v1

latestOpenAPI 3.1.02026-07-241040774.6 KB

Criar assinatura avulsa

Fornecemos a possibilidade de criação de uma assinatura (subscription) sem a necessidade de criação de um plano (plan).

post/subscriptions.

Request body

codestring

Código da assinatura no sistema da loja. Máx.: 52 caracteres

payment_methodstring

Meio de pagamento. Valores possíveis: credit_card, boleto e debit_card .

currencystring

Moeda. Valores possíveis: BRL

start_atstring

Data de início da assinatura. Se não for informada, a assinatura será iniciada imediatamente.

intervalstring

Intervalo da recorrência. Valores possíveis: day, week, month ou year.

minimum_priceinteger

Valor mínimo em centavos da assinatura.

interval_countinteger

Número de intervalos de acordo com a propriedade interval entre cada cobrança da assinatura. Ex.: plano mensal = interval_count (1) e interval (month) plano trimestral = interval_count (3) e interval (month) plano semestral = interval_count (6) e** interval** (month)

billing_typestring

Tipo de cobrança. Valores possíveis: prepaid, **postpaid **ou exact_day.

billing_dayinteger

Dia da cobrança. Obrigatório, caso o billing_type seja exact_day

installmentsinteger

Quantidade de parcelas. Será aplicada caso o método de pagamento da assinatura seja cartão de crédito .

statement_descriptorstring

Texto exibido na fatura do cartão. Será aplicado caso o método de pagamento da assinatura seja cartão de crédito

customer_idstring required

Código do cliente. Obrigatório caso o customer não seja informado. Saiba mais sobre clientes

customerobject required

Dados do cliente. Obrigatório caso o customer_id não seja informado. Saiba mais sobre clientes

cardobject

Cartão - card_id é o código do cartão do cliente. - card_token é token do cartão gerado pelo checkout transparente. É obrigatório o envio de uma dessas identificações, caso o payment_method seja credit_card ou debit_card. Saiba mais sobre cartões.

gateway_affiliation_idstring

Código da afiliação no gateway.

boleto_due_daysinteger

Dias para expiração do boleto. (Caso não seja passado, será pego um valor padrão das configurações da loja)

metadataobject

Objeto chave/valor utilizado para armazenar informações adicionais sobre a assinatura. Saiba mais sobre metadata.

Response

200

idstring

codestring

start_atstring

intervalstring

interval_countinteger

billing_typestring

next_billing_atstring

payment_methodstring

currencystring

installmentsinteger

statusstring

created_atstring

updated_atstring

Example response

{
  "id": "sub_8RQW76TG8SOeYZro",
  "code": "3R0ZSQ5BJ5",
  "start_at": "2018-04-04T00:00:00Z",
  "interval": "month",
  "interval_count": 1,
  "billing_type": "prepaid",
  "current_cycle": {
    "id": "cycle_GvX8zgQU9NUemBm5",
    "start_at": "2018-04-04T00:00:00Z",
    "end_at": "2018-05-03T23:59:59Z",
    "billing_at": "2018-04-04T00:00:00Z"
  },
  "next_billing_at": "2018-05-04T00:00:00Z",
  "payment_method": "boleto",
  "currency": "BRL",
  "installments": 1,
  "status": "active",
  "created_at": "2018-04-04T20:59:01Z",
  "updated_at": "2018-04-04T20:59:01Z",
  "customer": {
    "id": "cus_a21Y9wCnVszRqVR5",
    "name": "Tony Stark",
    "email": "903c2a55-0ce0-47c5-8b64-fa6a3036f861@avengers.com",
    "created_at": "2018-04-04T20:59:01Z",
    "updated_at": "2018-04-04T20:59:01Z"
  },
  "items": [
    {
      "id": "si_6DOoWzDip7izX8xV",
      "name": "Premium",
      "description": "Sem anuncios",
      "quantity": 1,
      "status": "active",
      "created_at": "2018-04-04T20:59:01Z",
      "updated_at": "2018-04-04T20:59:01Z",
      "pricing_scheme": {
        "price": 1490,
        "scheme_type": "unit"
      }
    }
  ]
}