List invoices

GET 
/subscriptions/invoices

Retrieves a list of all invoices.

Filtering

This endpoint supports filtering. For the general syntax, see Filtering.

The following attributes and operators are supported.

Operator	Attribute	Description
eq	subscriber_id, subscription_id, outstanding, tax_required	Equals. Checks if the values of two operands are equal. If they are, the condition is true.

Request

Query Parameters

filter string
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

200

Success. A list of invoices is returned.

application/json

Schema

Schema

data SubscriptionInvoice[]
Array [
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.
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.
]
]
links object
anyOf
title

Example (from schema)

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "subscription_invoice",
      "attributes": {
        "billing_period": {
          "start": "2017-07-21T17:32:28Z",
          "end": "2017-07-21T17:32:28Z"
        },
        "invoice_items": [
          {
            "description": "Magazine issue",
            "price": {
              "currency": "USD",
              "amount": 100,
              "includes_tax": false
            },
            "product_id": "00000000-0000-0000-0000-000000000000",
            "from_time_period": "2017-01-10T11:41:19.244842Z",
            "until_time_period": "2017-01-10T11:41:19.244842Z"
          }
        ],
        "tax_items": [
          {
            "type": "tax_item",
            "name": "GST",
            "code": "20.0 % S",
            "rate": 0.2,
            "jurisdiction": "USA"
          }
        ],
        "outstanding": true,
        "number": 1,
        "tax_required": true,
        "payment_retries_limit_reached": false,
        "updated_at": "2017-01-10T11:41:19.244842Z",
        "created_at": "2017-01-10T11:41:19.244842Z"
      },
      "meta": {
        "owner": "store",
        "subscription_id": "00000000-0000-0000-0000-000000000000",
        "subscriber_id": "00000000-0000-0000-0000-000000000000",
        "price": {
          "currency": "USD",
          "amount": 100,
          "includes_tax": false
        },
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244842Z",
          "created_at": "2017-01-10T11:41:19.244842Z",
          "taxes_added_at": "2017-01-10T11:41:19.244842Z"
        },
        "proration_events": [
          {
            "proration_policy_id": "00000000-0000-0000-0000-000000000000",
            "billing_cost_before_proration": 100,
            "refunded_amount_for_unused_plan": 100,
            "new_plan_cost": 100,
            "prorated_at": "2017-01-10T11:41:19.244842Z"
          }
        ]
      }
    }
  ],
  "links": {}
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

missing-name

{
  "errors": [
    {
      "title": "Validation Error",
      "status": "400",
      "detail": "data.attributes.name: \"name\" is required"
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
status stringrequired
The HTTP response code of the error.
title stringrequired
A brief summary of the error.
detail string
Optional additional detail about the error.
meta object
Additional supporting meta data for the error.
]

Example (from schema)

{
  "errors": [
    {
      "status": 500,
      "title": "Internal server error",
      "detail": "An internal error has occurred.",
      "meta": {
        "missing_ids": [
          "e7d50bd5-1833-43c0-9848-f9d325b08be8"
        ]
      }
    }
  ]
}

internal-server-error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500"
    }
  ]
}

Loading...