Skip to main content
Lista checkouts da mesma forma que GET /v1/checkouts, porém restringe implicitamente o catálogo à sub-organização :orgId: só entram sessões cujo product_id resolve para um produto com organization_id igual a :orgId. Use quando quiser uma URL explícita por vendedor filho (análogo a /v1/sdk/organizations/:orgId/products e /discounts), em integrações de marketplace.

​
Autenticação

  • Supabase JWT da organização pai (Authorization: Bearer).
  • A API verifica em organization_relationships que o token pertence ao pai direto de :orgId.

​
Escopos

É necessário pelo menos um dos escopos: web:read, web:write ou checkouts:read (mesma regra que GET /v1/checkouts).

​
Parâmetros de path

​
orgId
string
required
UUID da sub-organização (filha). Apenas checkouts cujo produto principal pertence a essa org entram no resultado (após os filtros abaixo).

​
Query (opcional)

Os parâmetros são os mesmos de GET /v1/checkouts. O filtro por organização não precisa ser enviado no query: ele é aplicado automaticamente com :orgId.
​
product_id
string
Restringe a checkouts com esse produto principal (deve ser produto da sub-org; caso contrário a lista pode ficar vazia).
​
customer_id
string
Filtra por cliente associado ao checkout.
​
status
string
Um ou mais valores: open, confirmed, succeeded, failed, expired (conforme suporte da API para múltiplos valores).
​
query
string
Busca parcial por e-mail do cliente (customer_email).
​
limit
integer
Tamanho da página. Padrão: 20.
​
page
integer
Página (base 1). Padrão: 1.
​
sorting
string
Ordenação estilo Polar, ex.: -created_at. Pode ser repetido na query HTTP se o cliente enviar vários sorting=.

​
Resposta

Objeto com items (lista de checkouts) e pagination:
  • total_count — total de registros
  • max_page — última página para o limit usado

​
Erros comuns

HTTPMotivo
401Token ausente ou inválido
403Token não é JWT de pai de :orgId, ou escopos insuficientes
500Erro interno ao consultar o banco

​
Exemplos

​
Listar primeira página (todos os checkouts abertos do filho)

curl -s -G "${API_BASE:-https://api.chargefy.io/api}/v1/sdk/organizations/${CHILD_ORG_ID}/checkouts" \
  --data-urlencode "status=open" \
  --data-urlencode "limit=20" \
  --data-urlencode "page=1" \
  --data-urlencode "sorting=-created_at" \
  -H "Authorization: Bearer ${PARENT_JWT}" \
  -H "Accept: application/json" | jq .

​
Filtrar por produto e por texto no e-mail do cliente

curl -s -G "${API_BASE:-https://api.chargefy.io/api}/v1/sdk/organizations/${CHILD_ORG_ID}/checkouts" \
  --data-urlencode "product_id=${CHILD_PRODUCT_ID}" \
  --data-urlencode "query=acme.com" \
  -H "Authorization: Bearer ${PARENT_JWT}" \
  -H "Accept: application/json" | jq .

​
Variáveis úteis (bash)

export API_BASE="https://api.chargefy.io/api"
export PARENT_JWT="<supabase_jwt>..."   # JWT da org pai (marketplace)
export CHILD_ORG_ID="uuid_sub_org"
export CHILD_PRODUCT_ID="uuid_produto_da_sub_org"