Interface SubscriptionsApiListSubscriptionsRequest

Request parameters for listSubscriptions operation in SubscriptionsApi.

Export

SubscriptionsApiListSubscriptionsRequest

Hierarchy

  • SubscriptionsApiListSubscriptionsRequest

Properties

customer_id? limit? metadata? next_payment_at_gte? next_payment_at_lte? offset? status? tilled_account

Properties

Optional Readonly customer_id

customer_id?: string

The ID of the customer whose subscriptions will be retrieved.

Memberof

SubscriptionsApiListSubscriptions

Optional Readonly limit

limit?: number

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Memberof

SubscriptionsApiListSubscriptions

Optional Readonly metadata

metadata?: {
    [key: string]: string;
}

`metadata` key-value pairs to filter by. Only exact matches on the key-value pair(s) will be returned. Example: `?metadata[internal_customer_id]=7cb1159d-875e-47ae-a309-319fa7ff395b`.

Memberof

SubscriptionsApiListSubscriptions

Type declaration

  • [key: string]: string

Optional Readonly next_payment_at_gte

next_payment_at_gte?: string

Minimum `next_payment_at` value to filter by (inclusive).

Memberof

SubscriptionsApiListSubscriptions

Optional Readonly next_payment_at_lte

next_payment_at_lte?: string

Maximum `next_payment_at` value to filter by (inclusive).

Memberof

SubscriptionsApiListSubscriptions

Optional Readonly offset

offset?: number

The (zero-based) offset of the first item in the collection to return.

Memberof

SubscriptionsApiListSubscriptions

Optional Readonly status

status?: ListSubscriptionsStatus

The status of the subscriptions to retrieve.

Memberof

SubscriptionsApiListSubscriptions

Readonly tilled_account

tilled_account: string

The id of the Tilled Account (usually starting with the prefix `acct_`) that the request is performed on behalf of.

Memberof

SubscriptionsApiListSubscriptions

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc