younifyd
Menu

Retrieve Advance Invoice

Retrieve advance invoice

GET/subscriptions/{subscription-id}/retrieve_advance_invoice_schedule

Use it in a workflow

  1. Add a step and choose the Chargebee connector.
  2. Pick the Retrieve Advance Invoice action (under Chargebee API).
  3. Fill in the fields below, then reference the result from later steps as {{retrieveAdvanceInvoice.response.data}}.

Request

Path parameters

subscription-idstringrequired

Headers

chargebee-request-origin-devicestring

The device from which the customer has made the request

chargebee-request-origin-userstring (email)

The email address of your customer/user. Use this when the email address has only ASCII characters.

chargebee-request-origin-user-encodedstring (email)

The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header chargebee-request-origin-user is ignored.

chargebee-request-origin-ipstring

The IP address of the customer where the request originated

chargebee-business-entity-idstring

If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.

Response

Returns 200 with an object. Read it in later steps with {{retrieveAdvanceInvoice.response.data.<field>}}.

advance_invoice_schedulesarray<object>

<p class="mb-2">Resource object representing advance_invoice_schedule</p>

idstringrequired

<p class="mb-2">System-generated and immutable unique Id for the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">advance_invoice_schedule</code> .</p>

schedule_typestring

The type of advance invoice or advance invoicing schedule. \* specific_dates - The advance charges occur on specific dates. For each date, [a fixed number of billing cycles](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured. \* fixed_intervals - The advance charges occur at [fixed intervals of time](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#fixed_interval_schedule_terms_to_charge) .

One offixed_intervalsspecific_dates

fixed_interval_scheduleobject6 fields

<p class="mb-2">When the <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">schedule_type</code> is <code class="bg-gray-100 text-gray-800 font-medium border border-gray-300 rounded px-1.5 py-0.5 mx-1 text-sm font-mono whitespace-nowrap">fixed_intervals</code> , this object gives further details of the schedule.</p>

specific_dates_scheduleobject3 fields

The advance charges occur on specific dates. For each date, \[a fixed number of billing cycles\](/docs/api/advance_invoice_schedules/advance_invoice_schedule-object#specific_dates_schedule_terms_to_charge) is charged for. There can be up to 5 dates configured.

json
{
  "advance_invoice_schedules": null
}

Need more? See the Chargebee guide for connection setup and behaviour shared by every action.

Retrieve Advance Invoice — Chargebee — Documentation