{"templateId":"openapi_docs","versions":[{"version":"v1","label":"v1","link":"/api-reference/v1/subscription","default":false,"active":true,"folderId":"1b9c9f54"},{"version":"v2","label":"v2","link":"/api-reference/subscription","default":true,"active":false,"folderId":"1b9c9f54"}],"sharedDataIds":{"openAPIDocsStore":"oas-api-reference/@v1/index.yaml","sidebar":"sidebar-sidebar.yaml__api-reference_v1"},"props":{"definitionId":"api-reference/@v1/index.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api-reference/v1","seo":{"title":"Subscription","siteUrl":"https://developer.flute.com","description":"A subscription is a recurring payment.\nThe client authorizes a transaction at regular intervals, such as weekly, monthly, or annually.\n\nExamples include mortgages, leases, streaming media payments, and Insurance premiums.\nPayments represent:\n* **Recurring billing**. The transaction happens automatically on a set schedule without the client having to re-enter payment details.\n* **Pre-authorization**. The customer approves transactions for future charges.\n* **Fixed or variable amounts**. The transaction can be the same every cycle, such as for a streaming service or vary based on usage, such as a utility bill.\n* **Stored payment**. The transaction uses a vault or stored payment method.\nPayment methods include a credit or debit card (only sale transactions) and ACH electronic check.\n\nInstallments may be specified as a combination of:\n* Days of the month, such as the 1st, 15th, or 30th.\n* Weeks of the month, such as the first week or the third week.\n* Months, such as 1 (January), 3 (March), or 12 (December)\n\nInstallments may either specify:\n* A set number of payments, such as 36, 60, 360.\nFor example, this may be for a mortgage or car payment.\n* Be indefinite and not specify an end date or a number of payments.\nFor example, this may be for a streaming media subscription.\n\nThe following endpoints are available:\n\n`GET /sub-api/v1/subscriptions`<br>\nLists subscriptions associated with the merchant.\n\n`GET /sub-api/v1/subscriptions/{{subscriptionId}}`<br>\nLists subscriptions associated with a specified subscription identifier.\n\n`POST /sub-api/v1/subscriptions`<br>\nCreates a subscription.\n\n`GET /sub-api/v1/subscriptions/{{subscriptionId}}/payments`<br>\nLists the payment history from a specified subscription identifier.\n\n`PUT /sub-api/v1/subscriptions/{{subscriptionId}}/terminate`<br>\nTerminate or cancels the specified subscription identifier.\n","lang":"en-US","llmstxt":{"hide":true,"excludeFiles":[]}},"itemId":"subscription","disableAutoScroll":true,"metadata":{"subType":"openapi-operation"},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"remoteAddr":{"hostname":"developer.flute.com","port":4000,"ipAddress":"216.73.216.41"},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"main"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api-reference/v1/subscription","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}