> ## Documentation Index > Fetch the complete documentation index at: https://docs.creem.io/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve a subscription > Retrieve subscription details by ID. View status, billing cycle, customer info, and payment history. ## OpenAPI ````yaml get /v1/subscriptions openapi: 3.0.0 info: title: Creem API description: >- Creem is an all-in-one platform for managing subscriptions and recurring revenue, tailored specifically for today's SaaS companies. It enables you to boost revenue, enhance customer retention, and scale your operations seamlessly. version: v1 contact: name: Creem Support url: https://creem.io email: support@creem.io license: name: Commercial url: https://creem.io/terms termsOfService: https://creem.io/terms servers: - url: https://api.creem.io - url: https://test-api.creem.io security: [] tags: [] externalDocs: description: Creem Documentation url: https://docs.creem.io paths: /v1/subscriptions: get: tags: - Subscriptions summary: Retrieve a subscription description: >- Retrieve subscription details by ID. View status, billing cycle, customer info, and payment history. operationId: retrieveSubscription parameters: - name: subscription_id required: true in: query description: The unique identifier of the subscription schema: example: sub_1234567890 type: string responses: '200': description: Successfully retrieved the subscription content: application/json: schema: $ref: '#/components/schemas/SubscriptionEntity' '400': description: Bad Request - Invalid input parameters '401': description: Unauthorized - Invalid or missing API key '404': description: Not Found - Resource does not exist security: - ApiKey: [] components: schemas: SubscriptionEntity: type: object properties: id: type: string description: Unique identifier for the object. mode: $ref: '#/components/schemas/EnvironmentMode' object: type: string description: >- String representing the object's type. Objects of the same type share the same value. example: subscription product: description: The product associated with the subscription. oneOf: - $ref: '#/components/schemas/ProductEntity' - type: string customer: description: The customer who owns the subscription. oneOf: - $ref: '#/components/schemas/CustomerEntity' - type: string items: description: Subscription items. type: array items: $ref: '#/components/schemas/SubscriptionItemEntity' collection_method: $ref: '#/components/schemas/SubscriptionCollectionMethod' example: charge_automatically status: $ref: '#/components/schemas/SubscriptionStatus' example: active last_transaction_id: type: string description: The ID of the last paid transaction. example: tran_3e6Z6TzvHKdsjEgXnGDEp0 last_transaction: description: The last paid transaction. allOf: - $ref: '#/components/schemas/TransactionEntity' last_transaction_date: format: date-time type: string description: The date of the last paid transaction. example: '2024-09-12T12:34:56Z' next_transaction_date: format: date-time type: string description: The date when the next subscription transaction will be charged. example: '2024-09-12T12:34:56Z' current_period_start_date: format: date-time type: string description: The start date of the current subscription period. example: '2024-09-12T12:34:56Z' current_period_end_date: format: date-time type: string description: The end date of the current subscription period. example: '2024-09-12T12:34:56Z' canceled_at: type: string description: The date and time when the subscription was canceled, if applicable. example: '2024-09-12T12:34:56Z' format: date-time nullable: true created_at: format: date-time type: string description: The date and time when the subscription was created. example: '2024-01-01T00:00:00Z' updated_at: type: string description: The date and time when the subscription was last updated. example: '2024-09-12T12:34:56Z' format: date-time discount: type: object description: The discount code applied to the subscription, if any. required: - id - mode - object - product - customer - collection_method - status - created_at - updated_at EnvironmentMode: type: string description: String representing the environment. enum: - test - prod - sandbox ProductEntity: type: object properties: id: type: string description: Unique identifier for the object. mode: $ref: '#/components/schemas/EnvironmentMode' object: type: string description: >- String representing the object's type. Objects of the same type share the same value. name: type: string description: The name of the product description: type: string description: A brief description of the product example: This is a sample product description. image_url: type: string description: URL of the product image. Only png as jpg are supported example: https://example.com/image.jpg features: description: Features of the product. type: array items: $ref: '#/components/schemas/FeatureEntity' price: type: number description: The price of the product in cents. 1000 = $10.00 example: 400 currency: type: string description: >- Three-letter ISO currency code, in uppercase. Must be a supported currency. example: USD billing_type: $ref: '#/components/schemas/ProductBillingType' example: recurring billing_period: $ref: '#/components/schemas/ProductBillingPeriod' example: every-month status: $ref: '#/components/schemas/ProductStatus' tax_mode: $ref: '#/components/schemas/TaxMode' example: inclusive tax_category: $ref: '#/components/schemas/TaxCategory' example: saas product_url: type: string description: >- The product page you can redirect your customers to for express checkout. example: https://creem.io/product/prod_123123123123 default_success_url: type: string description: >- The URL to which the user will be redirected after successfull payment. example: https://example.com/?status=successful nullable: true custom_fields: description: >- Custom fields configured for the product. Collect additional information from your customer during checkout. nullable: true type: array items: $ref: '#/components/schemas/CustomField' created_at: format: date-time type: string description: Creation date of the product example: '2023-01-01T00:00:00Z' updated_at: format: date-time type: string description: Last updated date of the product example: '2023-01-01T00:00:00Z' required: - id - mode - object - name - description - price - currency - billing_type - billing_period - status - tax_mode - tax_category - created_at - updated_at CustomerEntity: type: object properties: id: type: string description: Unique identifier for the object. mode: $ref: '#/components/schemas/EnvironmentMode' object: type: string description: >- String representing the object’s type. Objects of the same type share the same value. email: type: string description: Customer email address. example: user@example.com name: type: string description: Customer name. example: John Doe nullable: true country: type: string description: The ISO alpha-2 country code for the customer. example: US pattern: ^[A-Z]{2}$ created_at: format: date-time type: string description: Creation date of the product example: '2023-01-01T00:00:00Z' updated_at: format: date-time type: string description: Last updated date of the product example: '2023-01-01T00:00:00Z' required: - id - mode - object - email - country - created_at - updated_at SubscriptionItemEntity: type: object properties: id: type: string description: Unique identifier for the object. mode: $ref: '#/components/schemas/EnvironmentMode' object: type: string description: >- String representing the object’s type. Objects of the same type share the same value. product_id: type: string description: The ID of the product associated with the subscription item. price_id: type: string description: The ID of the price associated with the subscription item. units: type: number description: The number of units for the subscription item. nullable: true required: - id - mode - object SubscriptionCollectionMethod: type: string description: The method used for collecting payments for the subscription. enum: - charge_automatically SubscriptionStatus: type: string description: The current status of the subscription. enum: - active - canceled - unpaid - paused - trialing - scheduled_cancel TransactionEntity: type: object properties: id: type: string description: Unique identifier for the object. mode: $ref: '#/components/schemas/EnvironmentMode' object: type: string description: >- String representing the object's type. Objects of the same type share the same value. example: transaction amount: type: number description: The transaction amount in cents. 1000 = $10.00 example: 2000 amount_paid: type: number description: The amount the customer paid in cents. 1000 = $10.00 example: 2000 nullable: true discount_amount: type: number description: The discount amount in cents. 1000 = $10.00 example: 2000 nullable: true currency: type: string description: >- Three-letter ISO currency code, in uppercase. Must be a supported currency. example: USD type: $ref: '#/components/schemas/TransactionType' tax_country: type: string description: The ISO alpha-2 country code where tax is collected. example: US pattern: ^[A-Z]{2}$ nullable: true tax_amount: type: number description: The sale tax amount in cents. 1000 = $10.00 example: 2000 nullable: true status: $ref: '#/components/schemas/TransactionStatus' refunded_amount: type: number description: The amount that has been refunded in cents. 1000 = $10.00 example: 2000 nullable: true order: type: string description: The order associated with the transaction. nullable: true subscription: type: string description: The subscription associated with the transaction. nullable: true customer: type: string description: The customer associated with the transaction. nullable: true description: type: string description: The description of the transaction. period_start: type: number description: Start period for the invoice as timestamp period_end: type: number description: End period for the invoice as timestamp created_at: type: number description: Creation date of the order as timestamp required: - id - mode - object - amount - currency - type - status - created_at FeatureEntity: type: object properties: id: type: string description: Unique identifier for the feature. example: feat_abc123 type: $ref: '#/components/schemas/ProductFeatureType' example: licenseKey description: type: string description: A brief description of the feature. example: Access to premium course materials. required: - id - type - description ProductBillingType: type: string description: >- Indicates the billing method for the customer. It can either be a `recurring` billing cycle or a `onetime` payment. enum: - recurring - onetime ProductBillingPeriod: type: string description: Billing period enum: - every-month - every-three-months - every-six-months - every-year - once ProductStatus: type: string description: Status of the product enum: - active - archived TaxMode: type: string description: >- 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. enum: - inclusive - exclusive TaxCategory: type: string description: >- 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. enum: - saas - digital-goods-service - ebooks CustomField: type: object properties: type: $ref: '#/components/schemas/CustomFieldType' key: type: string description: >- Unique key for custom field. Must be unique to this field, alphanumeric, and up to 200 characters. maxLength: 200 label: type: string description: >- The label for the field, displayed to the customer, up to 50 characters maxLength: 200 optional: type: boolean description: >- Whether the customer is required to complete the field. Defaults to `false`. nullable: true text: description: Configuration for text field type. nullable: true allOf: - $ref: '#/components/schemas/Text' checkbox: description: Configuration for checkbox field type. nullable: true allOf: - $ref: '#/components/schemas/Checkbox' required: - type - key - label TransactionType: type: string description: >- The type of transaction. payment(one time payments) and invoice(subscription) enum: - payment - invoice TransactionStatus: type: string description: Status of the transaction. enum: - pending - paid - refunded - partialRefund - chargedBack - uncollectible - declined - void ProductFeatureType: type: string description: >- The type of the feature: privateNote (custom note), file (downloadable files), or licenseKey (license key). enum: - custom - file - licenseKey CustomFieldType: type: string description: The type of the field. enum: - text - checkbox Text: type: object properties: max_length: type: number description: Maximum character length constraint for the input. nullable: true minimum_length: type: number description: Minimum character length requirement for the input. nullable: true value: type: string description: The value of the input. nullable: true Checkbox: type: object properties: label: type: string description: The markdown text to display for the checkbox. nullable: true value: type: boolean description: The value of the checkbox (checked or not). nullable: true securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: >- API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys. ```` Built with [Mintlify](https://mintlify.com).