Skip to main content

Get invoice

GET 

/subscriptions/invoices/:invoice_uuid

Get invoice

Request

Path Parameters

    invoice_uuid UUIDrequired

    The unique identifier of the invoice.

Responses

Success. The details of the invoice are returned.

Schema
    data SubscriptionInvoice
    id UUID (string)

    The unique identifier.

    type SubscriptionInvoiceType (string)required

    Possible values: [subscription_invoice]

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

    attributes SubscriptionInvoiceAttributesrequired
    billing_period TimePeriodrequired

    A period of time between a start and end point.

    start date-timerequired

    The date and time a billing period started.

    end date-timerequired

    The date and time a billing period ended.

    invoice_items SubscriptionInvoiceItem[]required
  • Array [
  • description stringrequired

    A description of the subscribed item.

    price 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.

    product_id UUID (string)

    The unique identifier.

    from_time_period string

    The start date and time of the billing period in this price

    until_time_period string

    The end date and time of the billing period in this price

  • ]
  • tax_items TaxItem[]
  • Array [
  • type stringrequired

    Possible values: [tax_item]

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

    name string

    Possible values: <= 1024 characters

    The name that appears on your customer's invoice and usually describes the specific type of tax, for example, Sales, VAT or GST.

    code string

    Possible values: <= 1024 characters

    The unique identifier assigned to goods and services for taxation purposes.

    rate doublerequired

    The tax rate is the percentage of the subscription amount that is required to be paid as tax.

    jurisdiction string

    Possible values: <= 1024 characters

    The geographic area or political entity that has authority to levy and collect taxes.

  • ]
  • outstanding booleanrequired

    The invoice still requires payment if true.

    number integer

    A sequential number assigned by the billing run.

    tax_required booleanrequired

    Whether tax is required for this invoice.

    payment_retries_limit_reached booleanrequired

    Whether the limit of payment retries has been reached.

    updated_at string

    The date and time an invoice was updated.

    created_at string

    The date and time an invoice was created.

    manual_payment_pending booleanrequired

    Whether there is a manual pending payment pending on the invoice.

    meta SubscriptionInvoiceMetarequired
    owner stringrequired

    The owner of a resource, either store or organization.

    subscription_id UUID (string)

    The unique identifier.

    subscriber_id UUID (string)

    The unique identifier.

    price SingleCurrencyPrice

    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.

    timestamps Timestampsrequired
    updated_at stringrequired

    The date and time a resource was updated.

    created_at stringrequired

    The date and time a resource was created.

    taxes_added_at string

    The date and time taxes were added to an invoice.

    proration_events ProrationEvent[]required
  • Array [
  • proration_policy_id UUID (string)required

    The unique identifier.

    billing_cost_before_proration int64required

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

    refunded_amount_for_unused_plan int64required

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

    new_plan_cost int64required

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

    prorated_at stringrequired

    The date and time the subscription was prorated.

  • ]
Loading...