Voltar para Payment Service

cancelSubscription

ENDPOINT
System
Payment Service
Type
ENDPOINT
Created
18/02/2026, 22:10
Updated
18/02/2026, 22:10

Config

path: "/v1/subscriptions/{subscriptionId}"
method: "DELETE"
provider: "Stripe"
timeoutMs: 20000
environment: "sandbox|production"
idempotencyKeyHeader: "Idempotency-Key"

Input Schema

type: "object"
required:
0"authStripeSecretKeyRef"
1"subscriptionId"
2"idempotencyKey"
properties:
idempotencyKey:
subscriptionId:
cancelAtPeriodEnd:
authStripeSecretKeyRef:

Outputs (2)

errorERROR

Resposta de erro

type: "object"
properties: {}
successSUCCESS

Resposta de sucesso

type: "object"
required:
0"cancelled"
1"status"
2"effectiveDate"
3"subscriptionId"
properties:
status:
cancelled:
canceledAt:
effectiveDate:
subscriptionId:

Used in Flows (1)

FlowStep Order
Subscription Cancelation Flow#1