--- title: "List customer subscriptions" method: GET path: "/v1/customers/{id}/subscriptions" tags: ["Customers"] --- # List customer subscriptions `GET /v1/customers/{id}/subscriptions` Retrieve a paginated list of subscriptions for a specific customer. ## Path parameters - `id` string, required ## Query parameters - `page_number` number - `page_size` number ## Response `200` Successfully retrieved customer subscriptions - SubscriptionListEntity - `items` SubscriptionEntity[], required — List of subscription items - `id` string, required — Unique identifier for the object. - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment. - `object` string, required — String representing the object's type. Objects of the same type share the same value. - `product` union, required — The product associated with the subscription. - ProductEntity - `id` string, required — Unique identifier for the object. - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment. - `object` string, required — String representing the object's type. Objects of the same type share the same value. - `name` string, required — The name of the product - `description` string, required — A brief description of the product - `image_url` string — URL of the product image. Only png as jpg are supported - `image_urls` string[] — Ordered list of product image URLs. The first entry is the cover image (mirrored in image_url). - `features` FeatureEntity[] — Features of the product. - `id` string, required — Unique identifier for the feature. - `type` 'custom' | 'file' | 'licenseKey' | 'customerCredits', required — The type of the feature: `custom` (private note), `file` (downloadable files), `licenseKey` (license key), or `customerCredits` (customer credit grant). - `description` string, required — A brief description of the feature. - `price` number, required — The price of the product in cents. 1000 = $10.00 - `currency` string, required — Three-letter ISO currency code, in uppercase. Must be a supported currency. - `billing_type` 'recurring' | 'onetime', required — Indicates the billing method for the customer. It can either be a `recurring` billing cycle or a `onetime` payment. - `billing_period` 'every-month' | 'every-three-months' | 'every-six-months' | 'every-year' | 'every-day' | 'once', required — Billing period - `status` 'active' | 'archived', required — Lifecycle status of the product: `active` or `archived`. - `tax_mode` 'inclusive' | 'exclusive', required — Specifies the tax calculation mode for the transaction. If set to "inclusive," the tax is included in the price. If set to "exclusive," the tax is added on top of the price. - `tax_category` 'saas' | 'digital-goods-service' | 'ebooks', required — Categorizes the type of product or service for tax purposes. This helps determine the applicable tax rules based on the nature of the item or service. - `product_url` string — The product page you can redirect your customers to for express checkout. - `default_success_url` string, nullable — The URL to which the user will be redirected after successfull payment. - `custom_fields` CustomField[], nullable — Custom fields configured for the product. Collect additional information from your customer during checkout. - `type` 'text' | 'checkbox', required — The type of the field. - `key` string, required — Unique key for custom field. Must be unique to this field, alphanumeric, and up to 200 characters. - `label` string, required — The label for the field, displayed to the customer, up to 50 characters - `optional` boolean, nullable — Whether the customer is required to complete the field. Defaults to `false`. - `text` Text - `max_length` number, nullable — Maximum character length constraint for the input. - `minimum_length` number, nullable — Minimum character length requirement for the input. - `value` string, nullable — The value of the input. - `checkbox` Checkbox - `label` string, nullable — The markdown text to display for the checkbox. - `value` boolean, nullable — The value of the checkbox (checked or not). - `created_at` string, date-time, required — Creation date of the product - `updated_at` string, date-time, required — Last updated date of the product - string - `customer` union, required — The customer who owns the subscription. - CustomerEntity - `id` string, required — Unique identifier for the object. - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment. - `object` string, required — String representing the object’s type. Objects of the same type share the same value. - `email` string, required — Customer email address. - `name` string, nullable — Customer name. - `metadata` object, nullable — Additional metadata associated with the customer. - `country` string, nullable, required — The ISO 3166-1 alpha-2 country code for the customer. - `created_at` string, date-time, required — Creation date of the customer - `updated_at` string, date-time, required — Last updated date of the customer - string - `items` SubscriptionItemEntity[] — Subscription items. - `id` string, required — Unique identifier for the object. - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment. - `object` string, required — String representing the object’s type. Objects of the same type share the same value. - `product_id` string — The ID of the product associated with the subscription item. - `price_id` string — The ID of the price associated with the subscription item. - `units` number, nullable — The number of units for the subscription item. - `collection_method` 'charge_automatically', required — The method used for collecting payments for the subscription. - `status` 'active' | 'canceled' | 'unpaid' | 'paused' | 'trialing' | 'scheduled_cancel' | 'past_due', required — The current status of the subscription. - `last_transaction_id` string — The ID of the last paid transaction. - `last_transaction` TransactionEntity - `id` string, required — Unique identifier for the object. - `mode` 'test' | 'prod' | 'sandbox', required — String representing the environment. - `object` string, required — String representing the object's type. Objects of the same type share the same value. - `amount` number, required — The transaction amount in cents. 1000 = $10.00 - `amount_paid` number, nullable — The amount the customer paid in cents. 1000 = $10.00 - `discount_amount` number, nullable — The discount amount in cents. 1000 = $10.00 - `currency` string, required — Three-letter ISO currency code, in uppercase. Must be a supported currency. - `type` 'payment' | 'invoice', required — The type of transaction. payment(one time payments) and invoice(subscription) - `tax_country` string, nullable — The ISO alpha-2 country code where tax is collected. - `tax_amount` number, nullable — The sale tax amount in cents. 1000 = $10.00 - `status` 'pending' | 'paid' | 'refunded' | 'partialRefund' | 'chargedBack' | 'uncollectible' | 'declined' | 'canceled' | 'void', required — Status of the transaction. - `refunded_amount` number, nullable — The amount that has been refunded in cents. 1000 = $10.00 - `order` string, nullable — The order associated with the transaction. - `subscription` string, nullable — The subscription associated with the transaction. - `customer` string, nullable — The customer associated with the transaction. - `description` string — The description of the transaction. - `period_start` number — Start period for the invoice as timestamp - `period_end` number — End period for the invoice as timestamp - `created_at` number, required — Creation date of the order as timestamp - `last_transaction_date` string, date-time — The date of the last paid transaction. - `next_transaction_date` string, date-time — The date when the next subscription transaction will be charged. - `current_period_start_date` string, date-time — The start date of the current subscription period. - `current_period_end_date` string, date-time — The end date of the current subscription period. - `canceled_at` string, date-time, nullable — The date and time when the subscription was canceled, if applicable. - `created_at` string, date-time, required — The date and time when the subscription was created. - `updated_at` string, date-time, required — The date and time when the subscription was last updated. - `discount` object — The discount applied to the subscription, if any. - `id` string — The unique identifier of the discount (e.g. dis_...). - `discountCode` string — The discount code applied to the subscription. - `name` string - `type` 'percentage' | 'fixed' - `amount` number - `duration` 'forever' | 'once' | 'repeating' - `durationInMonths` number - `metadata` object — Metadata for the subscription in the form of key-value pairs. - `pagination` PaginationEntity, required - `total_records` number, required — Total number of records in the list - `total_pages` number, required — Total number of pages available - `current_page` number, required — The current page number - `next_page` number, nullable, required — The next page number, or null if there is no next page - `prev_page` number, nullable, required — The previous page number, or null if there is no previous page ## Other responses - `400` — Bad Request - Invalid input parameters - `401` — Unauthorized - Invalid or missing API key - `404` — Not Found - Resource does not exist --- [API](https://skmtc.net/creem/apis/creem-api.md) · [All operations](https://skmtc.net/creem/apis/creem-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/creem/creem-api/versions/aa593160d96c/schema)