> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-api/user-api/resources/billing/subscription.md). # Subscription Recurring payments taken through 2Checkout, listed and cancelled. A subscription is a recurring payment that renews the account's service automatically. These operations list the subscriptions in place and cancel one. Both work through [2Checkout](https://www.2checkout.com), formerly Avangate, which is why the paths carry `avangate`. Because they reach an external service, both can return error 215 when that service is unavailable. ## API actions API base path: `/subscription`. ### /subscription/avangate/ Working with [2Checkout](https://www.2checkout.com) (formerly [Avangate](http://www.avangate.com)) subscriptions (renewals). *** *Required sub-user rights:* `payment_create`. ## Cancel subscription > Unsubscribe from 2Checkout auto-renewal, by subscription reference.\ > \ > 2Checkout was formerly Avangate, which is where the path segment comes from.\ > \ > Also accepts GET with the same parameters as query-string values.\ > \ > Requires the \`payment\_create\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Billing","description":"Bills, payment systems, subscriptions, device plans and the transaction log. All resources under the /bill/, /payment_system/, /subscription/, /tariff/ and /transaction/ paths."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"OK":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true}}}}}},"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subscription/avangate/cancel":{"post":{"tags":["Billing"],"summary":"Cancel subscription","description":"Unsubscribe from 2Checkout auto-renewal, by subscription reference.\n\n2Checkout was formerly Avangate, which is where the path segment comes from.\n\nAlso accepts GET with the same parameters as query-string values.\n\nRequires the `payment_create` right.","operationId":"subscriptionAvangateCancel","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"reference":{"type":"string","description":"Internal 2Checkout subscription code. Take it from the `subscription/avangate/list` response. Must not be empty.","minLength":1}},"required":["reference"]}}}},"responses":{"200":{"description":"Auto-renewal cancelled","$ref":"#/components/responses/OK"},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` #### Errors These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes): * 215 - External service error. *** *Required sub-user rights:* `payment_create`. ## List subscriptions > List the active 2Checkout subscriptions, meaning renewals, of the current user.\ > \ > 2Checkout was formerly Avangate, which is where the path segment comes from.\ > \ > \*\*Returns error 201 when 2Checkout is not configured for the caller's dealer\*\*, which is the usual outcome on a platform that does not use it.\ > \ > Callable with an empty body. Also accepts GET.\ > \ > Requires the \`payment\_create\` right. ```json {"openapi":"3.1.0","info":{"title":"Navixy Platform API","version":"1.0.0"},"tags":[{"name":"Billing","description":"Bills, payment systems, subscriptions, device plans and the transaction log. All resources under the /bill/, /payment_system/, /subscription/, /tariff/ and /transaction/ paths."}],"servers":[{"url":"https://api.eu.navixy.com/v2","description":"Navixy production server on European platform"},{"url":"https://api.us.navixy.com/v2","description":"Navixy production server on American platform"},{"url":"https://api.me.navixy.com/v2","description":"Navixy production server on Middle East platform"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"type":"apiKey","description":"Either a user session hash or an API key, with the \"NVX \" prefix, for example \"NVX 22eac1c27af4be7b9d04da2ce1af111b\". Obtain a session hash from the userAuth operation, or create an API key from the API keys operations. A small number of operations accept a session hash only and reject an API key with error code 4; each says so in its description.","name":"Authorization","in":"header"}},"responses":{"ResponseError":{"description":"Error response object","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"Always false."},"status":{"type":"object","description":"Error status. Present only when an error occurred.","properties":{"code":{"type":"integer","description":"An error code in this API, not an HTTP code."},"description":{"type":"string","description":"An error description."}}},"errors":{"type":"array","description":"Per-parameter detail, returned with validation failures such as error code 7. A parameter name here may be an internal field name rather than the documented parameter name.","items":{"type":"object","properties":{"parameter":{"type":"string","description":"Name of the parameter that failed validation."},"error":{"type":"string","description":"What was wrong with it."}}}}}}}}}}},"paths":{"/subscription/avangate/list":{"post":{"tags":["Billing"],"summary":"List subscriptions","description":"List the active 2Checkout subscriptions, meaning renewals, of the current user.\n\n2Checkout was formerly Avangate, which is where the path segment comes from.\n\n**Returns error 201 when 2Checkout is not configured for the caller's dealer**, which is the usual outcome on a platform that does not use it.\n\nCallable with an empty body. Also accepts GET.\n\nRequires the `payment_create` right.","operationId":"subscriptionAvangateList","responses":{"200":{"description":"Active subscriptions","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","description":"`true` if request finished successfully.","readOnly":true},"list":{"type":"array","items":{"type":"object","description":"An active 2Checkout subscription.","properties":{"reference":{"type":"string","description":"Internal 2Checkout subscription code. Pass it to `subscription/avangate/cancel`."},"code":{"type":"string","description":"2Checkout product code."},"quantity":{"type":"integer","description":"Count."},"expiration_date":{"type":"string","description":"Next renewal date and time."}}}}}}}}},"400":{"description":"Bad request. The response body carries the API-level error code in `status.code`. Validation failures also include an `errors` array naming each offending parameter.","$ref":"#/components/responses/ResponseError"},"default":{"$ref":"#/components/responses/ResponseError"}}}}}} ``` #### Errors These errors come in addition to the [general error codes](/docs/navixy-api/general/errors.md#error-codes): * 215 - External service error. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://navixy.com/docs/navixy-api/user-api/resources/billing/subscription.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.