Skip to main content
POST
Atualizar item da assinatura
O code é o código do item enviado em items[].code na criação da assinatura. Envie pelo menos um dos campos quantity, amount ou description.
O amount é o valor unitário em centavos, de 0 a 1000000 (R$ 10.000,00). A alteração vale para as próximas faturas, e o amount da assinatura é recalculado na resposta.
Um code que não existe na assinatura retorna 404 (resource_missing).

Authorizations

Authorization
string
header
required

Chave de API (secret key) da conta, no formato sk_live_... (produção) ou sk_test_... (Dev mode). Envie no header Authorization: Bearer <chave>. Autentica todas as rotas da API v2 e as rotas de Análise de Fraude. A chave identifica a conta, então a API v2 não usa o header account. Uma chave só é aceita no ambiente em que foi criada. Gere a sua no dashboard em Configurações → Chaves de API.

Headers

Idempotency-Key
string

Chave de idempotência opcional e recomendada. Tem até 128 caracteres e vale por 24 horas, por conta. A mesma chave com o mesmo corpo devolve a resposta original (mesmo status e mesmo corpo), sem processar de novo. Só respostas 2xx ficam guardadas: depois de um erro, a mesma chave pode ser reutilizada. A mesma chave com um corpo diferente retorna 422 (idempotency_key_conflict), uma requisição original ainda em andamento retorna 409 (idempotency_key_in_use) e uma chave com mais de 128 caracteres retorna 400 (idempotency_key_invalid).

Maximum string length: 128
Example:

"pedido-1024-tentativa-1"

Path Parameters

id
string
required

Identificador do recurso (o campo id devolvido pela API)

code
string
required

Código do item da assinatura (o code enviado em items[].code ao criar a assinatura)

Example:

"SKU-SUB"

Body

application/json

Envie ao menos um dos campos

quantity
integer
Required range: x >= 1
Example:

2

amount
integer

Valor unitário, em centavos

Required range: 0 <= x <= 1000000
Example:

12000

description
string
Maximum string length: 255
Example:

"Assinatura Premium"

Response

Item atualizado

Assinatura. incomplete: a primeira fatura ainda não foi paga. incomplete_expired: a primeira fatura foi recusada. scheduled: a primeira cobrança está agendada (start_at). active: em dia. past_due: fatura em atraso. suspended: suspensa. canceled: cancelada. completed: todas as faturas previstas foram pagas.

id
string
Example:

"sub_4Hn8Qw2Rt6Yp1Zx3"

object
enum<string>
Available options:
subscription
code
string | null
Example:

"plano-anual-123"

status
enum<string>
Available options:
incomplete,
incomplete_expired,
scheduled,
active,
past_due,
suspended,
canceled,
completed
currency
string
Example:

"brl"

description
string | null
interval
enum<string>
Available options:
day,
week
interval_count
integer
billing_type
enum<string>
Available options:
prepaid
amount
integer

Total dos itens, em centavos, sem descontos ou acréscimos

items
object[]
discounts
object[]
increments
object[]
max_invoices
integer | null
invoices_paid
integer

Quantidade de faturas pagas

minimum_price
integer | null

Aceito e devolvido pela API, mas ainda não é aplicado na cobrança

payment_method
object
statement_descriptor
string | null
start_at
string | null
next_billing_at
string | null
created_at
string
customer
object
latest_invoice
object | null

Fatura de um ciclo da assinatura. processing: em processamento. requires_action: PIX aguardando pagamento ou verificação por código (veja next_action). paid: paga. failed: recusada (veja failure_reason). canceled: cancelada. refunded e partially_refunded: estornada. chargeback: contestada.

metadata
object