Assinaturas

Obter detalhes de uma assinatura específica

get/recurrence/subscriptions/{subscription_id}

Request

Base URL
https://api.b2b.usezapay.com.br/v2
Auth
HTTP basic
TypeScript
https://skmtc.dev/usezapay/apis/zapi/docs/recurrence/subscriptions/:subscription_id/get.ts
A function with typed inputs. Its response is checked against the schema.

subscription_idstring required

Assinatura criada com sucesso

subscription_idstring required

Id da assinatura.

payment_methodstring required

Meio de pagamento utilizado na assinatura.

interval_countinteger required

Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1)

plan_idstring nullable

Id do plano assinado.

billing_typestring required

next_billing_atstring date-time

Data do próximo faturamento da assinatura.

installmentsinteger nullable

Quantidade de parcelas aplicádas ao cartão de crédito.

external_idstring nullable

Id externo.

statusstring

created_atstring date-time required

Data de criação da assinatura.

updated_atstring date-time required

Data de atualização da assinatura.

metadataobject nullable

Dados adicionais da assinatura.

No recorded changes to this operation across all 1 revision of this API.