VoidhashDocs
DocumentationAPI reference
Dashboard
Essentials
API overview
Authentication
Endpoints
Ad_accounts
Analytics
Api_keys
Session
Component_dev_sessions
Component_registry
Components
Sandbox
Events
Experiments
Feature_flags
Ingest_policy
Push_notifications
Organizations
Payment_providers
Payment_provider_products
Payment_sources
Paywall_locations
Paywalls
Perks
Persons
Products
Projects
Push_notification_configurations
Schema
Sdk
Me
Webhooks
Audit_log
Organization_members
Notices
Connected_apps
Tracking_domains
Ads
Payment_provider_history_imports
Feedback
Analytics
Event capture
Upsert Transaction
Refund Transaction
Upsert Subscription
Cancel Subscription

Cancel Subscription

POST
/api/v1/projects/{projectId}/payment-providers/{paymentProviderId}/subscriptions/{externalId}/cancel

Path Parameters

projectId*string
paymentProviderId*string
externalId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

isImmediate?boolean|null

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/projects/string/payment-providers/string/subscriptions/string/cancel" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "paymentProviderId": "string",  "status": "applied",  "pendingReason": "product_not_mapped",  "subscriptionId": "string"}
{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "unauthenticated",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "permission_denied",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "not_found",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "conflict",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "internal",    "code": "string",    "message": "string",    "param": "string"  }}
{  "error": {    "type": "unavailable",    "code": "string",    "message": "string",    "param": "string"  }}
PreviousUpsert SubscriptionNextList