API Reference
  1. Aston — API Pública
  2. Assinaturas — Assinaturas

Create subscription

post
https://api.astongestao.com.br/subscriptions/

Create a new subscription

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64
required

ID Cliente

string
enum
required

Status da assinatura

Allowed:
date
required

Data do contrato

date

Data término do contrato

string

Descrição

string
enum
required

Tipo de pagamento

Allowed:
int64
required

Recorrência da assinatura

string
enum

Ação ao término do contrato (PAUSE_BILLING/CANCEL_CONTRACT)

Allowed:
string
enum

Forma de pagamento (à vista ou parcelado)

Allowed:
int32

Número de parcelas quando paymentForm=INSTALLMENT

string | null
\S.*

Código externo opcional (SKU, ERP)

date

Data de cancelamento (obrigatória quando status for CANCELLED)

int64

Id da justificativa de cancelamento (obrigatória quando status for CANCELLED)

boolean
required

Faturamento automático

int32
required
≥ 0

Quantidade de dias antes do vencimento para emissão da fatura

date
required

Data do próximo vencimento (>= hoje)

string
enum
required

Método de pagamento

Allowed:
int64

ID da conta bancária associada

int64

ID do cartão de crédito do parceiro associado

string
enum
required

Modo de emissão da NFS-e (NONE/WITH_INVOICE/AFTER_PAYMENT)

Allowed:
int64

ID do perfil fiscal (dados de ISS/serviço/NBS centralizados no módulo fiscal)

items
array of objects
required

Itens da assinatura

items*
subscriptionPlans
array of objects

Planos de assinatura a serem adicionados

subscriptionPlans
subContracts
array of objects

Subcontratos da assinatura

subContracts
string
enum

Forma de pagamento do pro rata escolhida no momento da criação (apenas pré-pago). Default NEXT_INVOICE.

Allowed:
Responses

Updated about 2 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*

Updated about 2 months ago

Did this page help you?