--- title: "GET /v1/subscription" method: GET path: "/v1/subscription" tags: ["subscription"] --- # GET /v1/subscription `GET /v1/subscription` ## Request - Base URL: `https://customer-portal-api.frisbii.com` - URL: `https://customer-portal-api.frisbii.com/v1/subscription` - Auth: none declared Get list of subscriptions ## Query parameters - `from` string: Time range from (inclusive). Local date and time (according to account timezone) on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm`, `yyyy-MM-ddTHH:mm:ss` or `yyyy-MM-ddTHH:mm:ss.SSS`. Default from if no `interval` is given depends on the query. If the query limits on relation e.g. customer and/or subscription, the default from will be epoch 1970-01-01, otherwise one month before `to` - `to` string: Time range to (exclusive). Local date and time (according to account timezone) on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm`, `yyyy-MM-ddTHH:mm:ss` or `yyyy-MM-ddTHH:mm:ss.SSS`. Defaults to now. - `interval` string: Limit from `to` and interval back in time. E.g. one week. Will take precedence over `from`. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations - `size` integer: Page size between 10 and 100 (default 20) - `next_page_token` string: Next page token from previous response to get next page - `language` string: Supported language for translation in lower case ## Response `200` Successful operation - CustomerSubscriptionList - `size` integer, required: Page size used in paginated list - `count` integer, required: Number of elements in current page. If less than page size it is the last page. - `to` string, required: Local date and time range used as to (exclusive) - `from` string, required: Local date and time range used as from (inclusive) - `content` CustomerSubscription[]: List of customer subscriptions - `handle` string: Per account unique handle for subscription - `plan` string: Subscription plan handle - `state` 'active' | 'expired' | 'on_hold' | 'pending': State of the subscription, one of the following: `active`, `expired`, `on_hold` or `pending`. - `created` string, date-time: Date when the subscription was created. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `plan_name` string: Subscription plan name - `in_trial` boolean: Whether the subscription is in its trial period, or if the subscription will start a trial period at a start date in the future. See `has_started` to determine if the actual trial period has started or not. - `is_cancelled` boolean: Whether the subscription has been cancelled. Cancelled subscriptions will expire at the end of the current billing period. - `is_withdrawal_eligible` boolean: Whether the customer can currently withdraw from the subscription under the EU statutory right of withdrawal. True when the customer has no VAT ID, the customer's country is an EU member state or not set, and no more than 14 days have passed since the subscription was activated (or started). The subscription state is not taken into account. - `next_period_start` string, date-time: Start date and time for the next billing period, and also end date and time for the current billing period. Is also the date and time for next invoice if the subscription is renewing. In ISO-8601 extended offset date-time format. - `start_date` string, date-time: Date and time from which the subscription is eligible to schedule invoices. Either from create or from the latest reactivate or subscription change. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `end_date` string, date-time: Fixed end date and time. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `current_period_start` string, date-time: Start date and time for the current billing period. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `first_period_start` string, date-time: Start date and time for the first ever billing period. In ISO-8601 extended offset date-time format. - `last_period_start` string, date-time: Start date and time for the previous billing period. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `trial_start` string, date-time: Start date and time of free trial period. In ISO-8601 extended offset date-time format. - `trial_end` string, date-time: End date and time of free trial period. In ISO-8601 extended offset date-time format. - `cancelled_date` string, date-time: Date when the subscription was cancelled. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `expires` string, date-time: Fixed date when the subscription will expire because of cancellation. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `expired_date` string, date-time: Date when the subscription expired. [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `on_hold_date` string, date-time: Date when the subscription was put on hold. [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `reactivated` string, date-time: Date when the subscription was reactivated from on hold. [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `activated` string, date-time: Date when the subscription was activated. Will only differ from created in a two step prepared -> activated subscription create scenario. In [ISO-8601](http://en.wikipedia.org/wiki/ISO_8601) extended offset date-time format. - `active_payment_methods` string[]: List of active payment method ids which are connected to this subscription - `next_page_token` string: Pagination token to use to get the next page. Notice that page size and range should be the same for all page requests. If not present the last page has been reached. ## Other responses - `400`: Invalid request, see error codes at https://api.frisbii.com/v1/error_codes - `401`: None or invalid credentials provided in access to secured resource - `403`: Not authorized to perform resource operation - `404`: Resource or referenced resource not found, see error codes at https://api.frisbii.com/v1/error_codes - `429`: Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123 - `500`: Internal service error, error is reported automatically to Frisbii --- [API](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api.md) - [All operations](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frisbii/apis/frisbii-customer-portal-api/revisions/f0261fb63b1b?raw)