Skip to main content
PATCH
Update a Subscription
Apenas metadata, failure_policy e retry_offsets_days são editáveis. Outros campos (intervalo, valor, moeda, cartão) são imutáveis — crie uma nova assinatura para alterá-los. Um webhook subscription.updated é disparado quando a assinatura é alterada.

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string<uuid>
obrigatório

Public subscription id (UUID).

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Corpo

application/json
metadata
object | null
failure_policy
enum<string>
Opções disponíveis:
immediate_cancel,
retry_then_cancel
retry_offsets_days
integer[]
Required array length: 1 - 10 elements
Intervalo obrigatório: 1 <= x <= 30

Resposta

Success

success
boolean
obrigatório
requestId
string
obrigatório
data
object
obrigatório