Invoice

Deprecated alias of created_at[gte]. When both arrive, created_at[gte] wins.

Deprecated alias of created_at[lte]. When both arrive, created_at[lte] wins.

Field to sort by. Required whenever any sort[...] key is present, so sending sort[direction] on its own returns 422. Send sort as an object (sort[field]=created_at), never as a scalar. When sort is omitted the list is ordered by id descending.

Possible values: id, created_at.

Sort direction; defaults to asc.

Possible values: asc, desc.

Defaults to "asc".

List of relations to expand in the response. Each expandable field on the response schema names its key, e.g. expand[]=customer. Nested keys use dot notation, e.g. items.product or subscriptions.items. Fields marked as always present are returned without being requested. An expanded list is null, not [], when there are no records. Unknown keys are ignored unless the endpoint says otherwise.

A query parameter failed validation: page below 1, per_page outside 1 to 100, a customer_id or subscription_id that does not belong to the shop, an unknown statuses[] value, a date not in 2022-02-24T04:00:00 format, sort[direction] without sort[field], an unknown sort field or direction, or a non-array expand[].

Invoice ID

Format: integer.

List of relations to expand in the response. Each expandable field on the response schema names its key, e.g. expand[]=customer. Nested keys use dot notation, e.g. items.product or subscriptions.items. Fields marked as always present are returned without being requested. An expanded list is null, not [], when there are no records. Unknown keys are ignored unless the endpoint says otherwise.

The expand[] parameter is not an array.

The invoice is not in open or past_due status.

Invoice ID

Format: integer.

List of relations to expand in the response. Each expandable field on the response schema names its key, e.g. expand[]=customer. Nested keys use dot notation, e.g. items.product or subscriptions.items. Fields marked as always present are returned without being requested. An expanded list is null, not [], when there are no records. Unknown keys are ignored unless the endpoint says otherwise.

The invoice is not in open or past_due status (invoice_status_not_allowed), or it has a processing payment intent (bad_request).

Invoice ID

Format: integer.

List of relations to expand in the response. Each expandable field on the response schema names its key, e.g. expand[]=customer. Nested keys use dot notation, e.g. items.product or subscriptions.items. Fields marked as always present are returned without being requested. An expanded list is null, not [], when there are no records. Unknown keys are ignored unless the endpoint says otherwise.

The invoice is not in open or past_due status (invoice_status_not_allowed), does not belong to a subscription, or it has a processing payment intent (bad_request).

Invoice ID

Format: integer.

List of relations to expand in the response. Each expandable field on the response schema names its key, e.g. expand[]=customer. Nested keys use dot notation, e.g. items.product or subscriptions.items. Fields marked as always present are returned without being requested. An expanded list is null, not [], when there are no records. Unknown keys are ignored unless the endpoint says otherwise.

The invoice is not in open or past_due status (invoice_status_not_allowed), does not belong to a subscription, or it has a processing payment intent (bad_request).