# List Subscription Plans Retrieve a list of . For details on how to query endpoints using the available parameters, see Query Parameters. Endpoint: GET /subscription_plans Version: 2022-02-01 Security: BasicAuth ## Header parameters: - `Finix-Version` (string) Specify the API version of your request. For more details, see Versioning. Example: "2022-02-01" ## Query parameters: - `amount` (integer) Filter by an amount equal to the given value. Example: 100 - `amount.lt` (integer) Filter by an amount less than. Example: 100 - `amount.lte` (integer) Filter by an amount less than or equal. Example: 100 - `amount.gt` (integer) Filter by an amount greater than. Example: 100 - `amount.gte` (integer) Filter by an amount greater than or equal. Example: 100 - `limit` (integer) The numbers of items to return. Example: 3 - `created_at.gte` (string) Filter where is after the given date. Example: "2022-09-27T11:21:23" - `created_at.lte` (string) Filter where is before the given date. Example: "2026-09-27T11:21:23" - `updated_at.gte` (string) Filter where is after the given date. Example: "2022-09-27T11:21:23" - `updated_at.lte` (string) Filter where is before the given date. Example: "2026-09-27T11:21:23" - `linked_to` (string) Filter subscription plans linked to a specific . Example: "MUcgYZswyRfqSSbvMsxuaHxZ" - `state` (string) Filter by : - ACTIVE - INACTIVE Example: "INACTIVE" - `after_cursor` (string) Return every resource created after the cursor value. - `before_cursor` (string) Return every resource created before the cursor value. ## Response 200 fields (application/json): - `page` (object) Details the page that's returned. - `page.limit` (integer) The number of entries to return. - `page.next_cursor` (string,null) The cursor to use for the next page of results. - `_embedded` (object) List of objects. - `_embedded.subscriptions` (array) objects. - `_embedded.subscriptions.id` (string) The ID of the resource. - `_embedded.subscriptions.created_at` (string) Timestamp of when the object was created. - `_embedded.subscriptions.updated_at` (string) Timestamp of when the object was last updated. - `_embedded.subscriptions.linked_to` (string) he ID of the [](#Merchants) resource that you wish to link to the (i.e., the merchant that the subscription plan belongs to). At this time, only approved merchants with one of the following processors are valid: - - - `_embedded.subscriptions.linked_type` (string) The type of the resource that is specified in the field. Enum: "MERCHANT" - `_embedded.subscriptions.billing_interval` (string) How often the subscriber is billed. Enum: "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY" - `_embedded.subscriptions.nickname` (string) A human-readable name for the resource. Example: "super important thing" - `_embedded.subscriptions.plan_name` (string) A human-friendly name for the . - `_embedded.subscriptions.description` (string) A description of the . - `_embedded.subscriptions.amount` (integer) The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). - `_embedded.subscriptions.currency` (string) ISO 4217 3-letter currency code. Currently, the only supported is . Enum: "USD" - `_embedded.subscriptions.billing_defaults` (object) Object containing default billing settings. - `_embedded.subscriptions.billing_defaults.collection_method` (string) The method by which subscription payments are collected. Currently, automatically billing the card on file is the only method available. Enum: "BILL_AUTOMATICALLY" - `_embedded.subscriptions.billing_defaults.send_invoice` (boolean) This feature has yet to be implemented. - `_embedded.subscriptions.billing_defaults.send_receipt` (boolean) This feature has yet to be implemented. - `_embedded.subscriptions.trial_defaults` (object) Object containing default trial settings. - `_embedded.subscriptions.trial_defaults.interval_type` (string) The unit of time for the trial period. Enum: "DAY", "WEEK", "MONTH", "YEAR" - `_embedded.subscriptions.trial_defaults.interval_count` (integer) The number of intervals of used to describe the duration of the trial. - `_embedded.subscriptions.discount_phase_defaults` (object) - `_embedded.subscriptions.discount_phase_defaults.billing_interval_count` (integer) The number of billing intervals the discount applies. After this period, the subscriber is charged the full . - `_embedded.subscriptions.state` (string) The state of the . Enum: "ACTIVE", "INACTIVE" - `_embedded.subscriptions.tags` (object,null) Include up to 50 pairs to annotate requests with custom metadata. - Maximum character length for individual is 40. - Maximum character length for individual is 500. (For example, , , ) - `_embedded.subscriptions._links` (object) An object containing link(s) relevant to the request. You can store these links for follow-up requests. - `_embedded.subscriptions._links.self` (object) - `_embedded.subscriptions._links.self.href` (string) The path to the new resource. - `_links` (object) For your convenience, every response includes several URLs which link to resources relevant to the request. You can use these to make your follow-up requests and quickly access relevant IDs. - `_links.next` (object) Link to the next page of entries. - `_links.next.href` (string) - `_links.self` (object) Link to the resource that was used in the request. ## Response 401 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "UNKNOWN" - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.self` (object) - `_embedded.errors._links.self.href` (string) - `_embedded.errors._links.source` (object) ## Response 403 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "FORBIDDEN" - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.source` (object) - `_embedded.errors._links.source.href` (string) ## Response 404 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "NOT_FOUND" - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.source` (object) - `_embedded.errors._links.source.href` (string) ## Response 422 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "INVALID_FIELD" - `_embedded.errors.field` (string) - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.source` (object) - `_embedded.errors._links.source.href` (string)