younifyd
Menu

Retrieve Payment Schedules For An Invoice

Retrieve payment schedules for an invoice

GET/invoices/{invoice-id}/payment_schedules

Use it in a workflow

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

Request

Path parameters

invoice-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 {{retrievePaymentSchedulesForAnInvoice.response.data.<field>}}.

payment_schedulesarray<object>

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

idstringrequired

An auto-generated unique identifier for the payment schedule.

scheme_idstringrequired

<p class="mb-2">The identifier of 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">payment_schedule_scheme</code> , used to create the payment schedules.</p>

entity_typestringrequired

Specifies the types of entity this payment schedule is based on. \* invoice - Indicates the invoice entity type

One ofinvoice

entity_idstringrequired

The identifier of the entity this payment schedule is based on.

amountinteger (int64)

<p class="mb-2">The part of 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">invoice.amount_due</code> to be distributed across the payment schedules. If not specified, the entire <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">invoice.amount_due</code> is considered by default.</p>

created_atinteger (unix-time)required

<p class="mb-2">The timestamp at which 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">payment_schedule</code> was created.</p>

resource_versioninteger (int64)

<p class="mb-2">Version number of this resource. 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">resource_version</code> is updated with a new timestamp in milliseconds for every change made to the resource. This attribute will be present only if the resource has been updated after 2016-09-28.</p>

updated_atinteger (unix-time)

Specifies when these payment schedules are updated recently.

currency_codestring

The currency code (ISO 4217 format) of the transaction amount.

schedule_entriesarray<object>4 fields

List of schedule entries

json
{
  "payment_schedules": null
}

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