Objeto Assinatura

Esse objeto contém os dados das assinaturas geradas pelo seu sistema, que são atreladas a um plano.

PropriedadeDescrição
objeto
String
Nome do tipo do objeto criado/modificado.
Valor retornado: subscription
plan
Object
Objeto com os dados do plano que a assinatura está associada
id
Integer
Número identificador da assinatura
current_transaction
Object
Objeto com os dados da última transação criada para essa assinatura
postback_url
String
Endpoint de sua aplicação irá receber as notificações de mudança de status da assinatura.
payment_method
String
Método de pagamento associado a essa assinatura
current_period_start
ISODate
Início do período atual de cobrança da assinatura em ISODate
card_brand
String
Bandeira do cartão usado para criar a assinatura.
card_last_digits
String
4 últimos dígitos do cartão usado para criar a assinatura.
current_period_end
ISODate
Fim do período atual de cobrança da assinatura em ISODate
charges
Integer
Número de cobranças que foram efetuadas na assinatura, sem contar a cobrança inicial da assinatura no caso de cartão de crédito.
status
String
Possíveis estados da assinatura
Sendo: trialing, paid, pending_payment, unpaid, canceled, ended
date_created
ISODate
Data da criação do plano ISODate
phone
Object
Objeto com dados do telefone do cliente
address
Object
Objeto com dados do endereço do cliente
customer
Object
Objeto com dados do cliente
card
Object
Objeto com dados do cartão do cliente
metadata
Object
Objeto com dados adicionais atrelados à assinatura
settled_charges
Integer
Quantidade de parcelas não pagas, e negociadas.
fine
Object
Objeto com dados de multa referente ao atraso no pagamento do boleto.
interest
Object
Objeto com dados dos juros referentes ao atraso no pagamento do boleto.
{
  "object": "subscription",
  "plan": {
    "object": "plan",
    "id": 164526,
    "amount": 15000,
    "days": 30,
    "name": "The Pro Plan - Platinum  - Rocks",
    "trial_days": 0,
    "date_created": "2017-06-09T22:43:08.048Z",
    "payment_methods": [
      "boleto",
      "credit_card"
    ],
    "color": null,
    "charges": null,
    "installments": 1,
    "invoice_reminder": null
  },
  "id": 205840,
  "current_transaction": {
    "object": "transaction",
    "status": "paid",
    "refuse_reason": null,
    "status_reason": "acquirer",
    "acquirer_response_code": "0000",
    "acquirer_name": "pagarme",
    "acquirer_id": "56f9d019decf72cc70055d58",
    "authorization_code": "211852",
    "soft_descriptor": null,
    "tid": 1627876,
    "nsu": 1627876,
    "date_created": "2017-06-18T06:45:51.193Z",
    "date_updated": "2017-06-18T06:45:51.742Z",
    "amount": 15000,
    "authorized_amount": 15000,
    "paid_amount": 15000,
    "refunded_amount": 0,
    "installments": 1,
    "id": 1627876,
    "cost": 50,
    "card_holder_name": "Susan Alexis",
    "card_last_digits": "4242",
    "card_first_digits": "424242",
    "card_brand": "visa",
    "card_pin_mode": null,
    "postback_url": null,
    "payment_method": "credit_card",
    "capture_method": "ecommerce",
    "antifraud_score": null,
    "boleto_url": null,
    "boleto_barcode": null,
    "boleto_expiration_date": null,
    "referer": "api_key",
    "ip": "189.8.94.42",
    "subscription_id": 205840,
    "split_rules": null,
    "metadata": {},
    "antifraud_metadata": {}
  },
  "postback_url": "https://api.aardvarl.com/1/handlepostback/subscription",
  "payment_method": "credit_card",
  "card_brand": "visa",
  "card_last_digits": "4242",
  "current_period_start": "2017-06-18T06:45:51.182Z",
  "current_period_end": "2017-07-18T06:45:51.182Z",
  "charges": 0,
  "status": "paid",
  "date_created": "2017-06-18T06:45:51.731Z",
  "phone": null,
  "address": null,
  "customer": {
    "object": "customer",
    "id": 198786,
    "external_id": null,
    "type": null,
    "country": null,
    "document_number": null,
    "document_type": "cpf",
    "name": null,
    "email": "[email protected]",
    "phones": null,
    "born_at": null,
    "birthday": null,
    "gender": null,
    "date_created": "2017-06-18T06:36:41.886Z",
    "documents": []
  },
  "card": {
    "object": "card",
    "id": "card_cj429yy5v01o8cd6eqgslolec",
    "date_created": "2017-06-18T05:32:06.646Z",
    "date_updated": "2017-06-18T05:33:03.995Z",
    "brand": "visa",
    "holder_name": "Chuck Silva",
    "first_digits": "424242",
    "last_digits": "4242",
    "country": "US",
    "fingerprint": "Ntjtk/Hk/QnY",
    "valid": true,
    "expiration_date": "1122"
  },
  "metadata": null,
  "fine": {
      "days": "5",
      "amount": "500"
  },
  "interest": {},
  "settled_charges": null
}