Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Subscription Plans

List Subscription Plans

Retrieve a list of Subscription Plan resources.

get/subscription_plans

Query parameters

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.

linked_tostring

Filter subscription plans linked to a specific Merchant.

plan_namestring

Filter by the plan name (exact match).

plan_name.likestring

Filter by the plan name (partial match).

statestring
Example:INACTIVE

Filter by state:

  • ACTIVE
  • INACTIVE
application_idstring
Example:APc9vhYcPsRuTSpKD9KpMtPe

Filter by Application ID.

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

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.

limitinteger
Example:10

The numbers of items to return.

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 Plan resources

Example response

{
  "_embedded": {
    "subscription_plans": [
      {
        "billing_interval": "MONTHLY",
        "amount": 5000,
        "discount_phase_defaults": {
          "amount": 5000
        }
      }
    ]
  }
}