> ## Documentation Index > Fetch the complete documentation index at: https://docs.tagada.io/llms.txt > Use this file to discover all available pages before exploring further. # Apply the retention offer the customer took instead of cancelling > Apply the retention offer the customer took instead of cancelling ## OpenAPI ````yaml /openapi.json post /api/v1/portal/cancel-flow/accept openapi: 3.0.3 info: title: TagadaPay API description: >- # TagadaPay API Documentation Welcome to the TagadaPay API. This REST API lets you process payments, manage subscriptions, handle customers, deploy plugins, and orchestrate checkout funnels — all programmatically. ## Authentication Authenticate every request with a Bearer token. Get your API key from the [TagadaPay Dashboard](https://app.tagada.io). ``` Authorization: Bearer your-api-key ``` All requests must be made over HTTPS with `Content-Type: application/json`. ## Rate Limits | Plan | Requests/min | Burst | |------|-------------|-------| | Standard | 100 | 150 | | Premium | 500 | 750 | Exceeding the limit returns `429 Too Many Requests`. ## Errors | Code | Meaning | |------|---------| | 400 | Bad request — invalid parameters | | 401 | Unauthorized — missing or invalid API key | | 403 | Forbidden — insufficient permissions | | 404 | Not found | | 409 | Conflict | | 429 | Rate limited | | 500 | Server error | ## Support - Email: api-support@tagada.io - Docs: [docs.tagadapay.com](https://docs.tagadapay.com) version: 1.0.0 servers: - url: https://api.tagada.io/ description: Production - url: https://api.tagada.dev/ description: Sandbox / Development security: - bearerAuth: [] tags: - name: auth description: Test your API key and verify authentication. - name: stores description: Create and manage stores within your account. - name: products description: Create products with variants, prices, and currency options. - name: customers description: Manage customer records, addresses, and payment instruments. - name: orders description: List and retrieve orders with line items, payments, and metadata. - name: payments description: Process, list, refund, void, and dispute payments. - name: subscriptions description: >- Create and manage recurring subscriptions — billing, cancellation, rebilling, and processor changes. - name: payment-flows description: Configure payment routing strategies with cascading processor fallbacks. - name: payment-instruments description: >- Manage stored payment methods — cards, bank accounts, and tokenized instruments. - name: processors description: List connected payment processors (Stripe, NMI, Checkout.com, etc.). - name: promotions description: Create and manage discount promotions with rules and conditions. - name: promotion-codes description: Generate and manage reusable promotion/coupon codes. - name: block-rules description: >- Configure fraud prevention rules to block transactions by IP, email, card BIN, country, etc. - name: webhooks description: Register webhook endpoints to receive real-time event notifications. - name: events description: Query application events, statistics, and audit logs. - name: domains description: Add, verify, and manage custom domains for your checkout and funnels. - name: funnels description: >- Create and manage checkout funnels with routing, A/B testing, and CDN deployment. - name: funnel-sessions description: Retrieve funnel session data for analytics and debugging. - name: funnel-tracking description: Track funnel step events for conversion analytics. - name: plugins description: Deploy, manage, and configure checkout plugins. - name: plugins-v2 description: >- V2 plugin system — deploy, mount, split-test, fork, promote, and manage plugin instances. - name: checkout description: >- Initialize checkout sessions and process payments through the hosted checkout. - name: 3ds description: >- 3D Secure authentication — create sessions, authenticate, and handle challenges. - name: builder description: Generate and validate builder session tokens for the visual page editor. - name: health description: API health check endpoint. - name: test description: Test and debugging utilities for the event system (sandbox only). paths: /api/v1/portal/cancel-flow/accept: post: tags: - portal summary: Apply the retention offer the customer took instead of cancelling description: Apply the retention offer the customer took instead of cancelling operationId: post-api-v1-portal-cancel-flow-accept parameters: [] requestBody: required: true content: application/json: schema: type: object properties: target: anyOf: - type: object properties: type: type: string enum: - subscription subscriptionId: type: string required: - type - subscriptionId additionalProperties: false - type: object properties: type: type: string enum: - membership required: - type additionalProperties: false reasonId: type: string minLength: 1 offerId: type: string minLength: 1 optionId: type: string minLength: 1 productId: type: string minLength: 1 variantId: type: string minLength: 1 days: type: integer minimum: 1 maximum: 365 required: - target - reasonId - offerId additionalProperties: false responses: '200': description: Successful response content: application/json: schema: type: object properties: subscription: type: object properties: id: type: string customerId: type: string status: type: string enum: - active - trialing - paused - past_due - canceled productId: type: string variantId: type: string optionId: type: string currency: type: string pattern: ^[A-Z]{3}$ quantity: type: integer minimum: 1 price: type: integer startedAt: anyOf: - type: string format: date - type: string format: date-time nextBillingAt: anyOf: - type: string format: date - type: string format: date-time nullable: true trialEndsAt: anyOf: - type: string format: date - type: string format: date-time nullable: true pausedUntil: anyOf: - type: string format: date - type: string format: date-time nullable: true canceledAt: anyOf: - type: string format: date - type: string format: date-time nullable: true cancelReasonId: type: string nullable: true skippedDates: type: array items: anyOf: - type: string format: date - type: string format: date-time lastPaymentFailedAt: anyOf: - type: string format: date - type: string format: date-time nullable: true paidOrdersCount: type: integer minimum: 0 nextOrderAddOns: type: array items: type: object properties: productId: type: string variantId: type: string quantity: type: integer minimum: 1 unitPrice: type: integer required: - productId - variantId - quantity - unitPrice additionalProperties: false paymentMethodId: type: string shippingAddressId: type: string required: - id - customerId - status - productId - variantId - optionId - currency - quantity - price - startedAt - nextBillingAt - trialEndsAt - pausedUntil - canceledAt - cancelReasonId - skippedDates - lastPaymentFailedAt - paymentMethodId - shippingAddressId additionalProperties: false nullable: true membership: type: object properties: id: type: string customerId: type: string programId: type: string status: type: string enum: - active - trialing - grace - canceled billing: type: string enum: - monthly - yearly startedAt: anyOf: - type: string format: date - type: string format: date-time renewsAt: anyOf: - type: string format: date - type: string format: date-time nullable: true trialEndsAt: anyOf: - type: string format: date - type: string format: date-time nullable: true graceEndsAt: anyOf: - type: string format: date - type: string format: date-time nullable: true canceledAt: anyOf: - type: string format: date - type: string format: date-time nullable: true creditsBalance: type: integer minimum: 0 savedToDate: type: integer paymentMethodId: type: string required: - id - customerId - programId - status - billing - startedAt - renewsAt - trialEndsAt - graceEndsAt - canceledAt - creditsBalance - savedToDate - paymentMethodId additionalProperties: false nullable: true required: - subscription - membership additionalProperties: false default: $ref: '#/components/responses/error' security: - cmsSession: [] components: responses: error: description: Error response content: application/json: schema: type: object properties: message: type: string code: type: string issues: type: array items: type: object properties: message: type: string required: - message additionalProperties: false required: - message - code additionalProperties: false securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: 'Enter your API key as: `Bearer your-api-key`' cmsSession: type: apiKey in: header name: x-cms-token description: >- CMS session JWT from /api/v1/cms/session/login. Customer account operations require an email-verified session; signed offer links accept an anonymous store session. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.