Skip to main content
POST
Atualizar um pedido
Aceita somente access_expires_at e metadata. Não altera o pagamento nem cancela uma assinatura. Pedidos de assinatura com status approved ou completed não aceitam validade de acesso nula. Requer orders:write ou write. Use Idempotency-Key ao repetir a mesma operação. Veja campos, relacionamentos e eventos.

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

Chave única por operação lógica, de 1 a 255 caracteres ASCII imprimíveis, sem espaços. Reutilize-a somente para repetir a mesma operação.

Required string length: 1 - 255

Path Parameters

id
string
required

ID público do pedido na conta.

Pattern: ^ord_[a-z0-9]{16}$

Body

application/json
access_expires_at
string<date-time> | null

Fim da validade de acesso, em ISO 8601 com fuso. Editável. Null representa ausência de prazo; assinaturas approved ou completed exigem uma data.

metadata
object

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

Response

Operação concluída

id
string
required

Identificador público estável. Use o valor retornado pela API nas consultas e relacionamentos; não derive IDs de nomes.

Pattern: ^ord_[a-z0-9]{16}$
access_expires_at
string<date-time> | null
required

Fim da validade de acesso, em ISO 8601 com fuso. Editável. Null representa ausência de prazo; assinaturas approved ou completed exigem uma data.

created_at
string<date-time>
required

Data e hora da criação, em ISO 8601 com fuso horário. Somente leitura.

currency
string
required

Moeda do pedido, BRL ou USD. Somente leitura.

customer
string | null
required

ID do cliente vinculado; pode ser null. Somente leitura.

Pattern: ^cus_[a-z0-9]{16}$
effective_order_at
string<date-time> | null
required

Data efetiva da compra em ISO 8601 com fuso. Pode ser null. Somente leitura.

metadata
object
required

Objeto JSON livre para referências da integração, limitado a 16 KB. Ao enviar, substitui todo o metadata anterior; use {} para limpar. Não aceita null.

object
string
required

Tipo do objeto retornado. O valor é fixo para este recurso.

Allowed value: "order"
order_number
integer
required

Número do pedido para exibição. Para chamadas da API, use id. Somente leitura.

payment_method
string | null
required

Método de pagamento registrado, como credit_card ou pix. Pode ser null. Somente leitura.

price
string | null
required

ID do preço vinculado; pode ser null. Somente leitura.

Pattern: ^prc_[a-z0-9]{16}$
product
string | null
required

ID do produto vinculado; pode ser null. Somente leitura.

Pattern: ^pro_[a-z0-9]{16}$
status
string
required

Estado registrado: pending, approved, completed, refunded, cancelled, chargeback ou disputed. Somente leitura.

subscription_status
string | null
required

Situação da assinatura vinculada: trialing, active, past_due, paused, cancelled ou expired. Pode ser null. Somente leitura.

type
string
required

Tipo do pedido: one_time (compra única) ou subscription (assinatura). Somente leitura.

unit_amount
integer
required

Valor do pedido em centavos da moeda indicada em currency. Somente leitura.

updated_at
string<date-time>
required

Data e hora da última alteração, em ISO 8601 com fuso horário. Somente leitura.