Skip to main content

List invoice payments

GET 

/subscriptions/invoices/:invoice_uuid/payments

List invoice payments

Request

Path Parameters

    invoice_uuid UUIDrequired

    The unique identifier of the invoice.

Query Parameters

    page[offset] int64

    Possible values: <= 10000

    The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

    page[limit] int64

    The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

Responses

Success. Payments for the invoice are returned

Schema
    data SubscriptionInvoicePayment[]
  • Array [
  • id UUID (string)required

    The unique identifier.

    type SubscriptionInvoicePaymentType (string)required

    Possible values: [subscription_invoice_payment]

    This represents the type of resource object being returned. Always subscription_invoice_payment.

    attributes SubscriptionInvoicePaymentAttributesrequired
    success booleanrequired

    Whether the payment was successful.

    pending boolean

    Whether the payment is pending (only for manual payments).

    gateway stringrequired

    Possible values: <= 1024 characters

    Specifies the payment gateway.

    external_payment_id string

    Possible values: <= 1024 characters

    An optional external ID that is specific to the gateway used.

    failure_detail object

    The reason the payment failed.

    reason string
    amount SingleCurrencyPricerequired

    A price in a single currency.

    currency stringrequired

    Possible values: <= 1024 characters

    The three-letter ISO currency code in uppercase, associated with a price.

    amount int64required

    The value as a whole number of the currency's smallest subdivision.

    includes_tax boolean

    Whether the amount includes any taxes.

    meta SubscriptionInvoicePaymentMetarequired
    owner stringrequired

    The owner of a resource, either store or organization.

    subscription_id UUID (string)required

    The unique identifier.

    invoice_id UUID (string)required

    The unique identifier.

    job_id UUID (string)required

    The unique identifier.

    timestamps Timestampsrequired
    updated_at stringrequired

    The date and time a resource was updated.

    created_at stringrequired

    The date and time a resource was created.

    payment_taken_at string

    The date and time a payment was taken.

    manual_payment booleanrequired

    Whether manual payments are enabled or the payment will be handled by the configured gateway.

  • ]
  • links object
    anyOf
    title
Loading...