Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Subscriptions

List Subscriptions

Retrieve a list of Subscription resources.

For details on how to query endpoints using the available parameters, see Query Parameters.

get/subscriptions

Query parameters

after_cursorstring

Return every resource created after the cursor value.

amount.gtinteger
Example:100

Filter by an amount greater than.

amount.gteinteger
Example:100

Filter by an amount greater than or equal.

amount.ltinteger
Example:100

Filter by an amount less than.

amount.lteinteger
Example:100

Filter by an amount less than or equal.

amountinteger
Example:100

Filter by an amount equal to the given value.

application_idstring
Example:APc9vhYcPsRuTSpKD9KpMtPe

Filter by Application ID.

before_cursorstring

Return every resource created before the cursor value.

billing_interval'BIMONTHLY' | 'BIWEEKLY' | 'BIYEARLY' | 'DAILY' | 'MONTHLY' | 'QUARTERLY' | 'SEMIYEARLY' | 'TRIYEARLY' | 'WEEKLY' | 'YEARLY'
Example:MONTHLY

Filter by billing frequency.

buyer_identity_idstring
Example:ID6Qm3BQUxGFcCWZ185TS8sn

Filter by the Buyer Identity's ID.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

idstring

Filter by id.

limitinteger
Example:10

The numbers of items to return.

linked_tostring
Example:MUcgYZswyRfqSSbvMsxuaHxZ

Filter subscriptions linked to a specific Merchant.

nicknamestring

Filter by the Subscription name (exact match).

nickname.likestring

Filter by the Subscription name (partial match).

statestring
Example:NOT_STARTED

Filter by state:

  • ACTIVE
  • CANCELED
  • EXPIRED
  • NOT_STARTED
  • PAST DUE
subscription_link_idstring
Example:subscription_link_cvTp2K5CNH9Lr4BqCphcM

Filter subscriptions created by a Subscription Link.

subscription_plan_idstring
Example:subscription_plan_ciLn19pSKDTFoehtH7ET

Filter subscriptions that were created using a specific Subscription Plan.

tags.keystring
Example:card_type

Filter by the tag's key. For more information, see Tags.

tags.valuestring
Example:business_card

Filter by the tag's value. For more information, see Tags.

updated_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where updated_at is after the given date.

updated_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where updated_at is before the given date.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Subscription resources

Example response

{
  "_embedded": {
    "Subscription": [
      {
        "amount": 5000,
        "billing_cycle_day": 1,
        "billing_interval": "MONTHLY",
        "subscription_plan_id": "subscription_plan_ctBbJ1ihsC8Hpju4RQfZE"
      }
    ]
  }
}