Criar Assinatura no Ecommerce

POST /ecommerce/createSubscription

HTTP

POST /ecommerce/createSubscription HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}

Rota para criar uma assinatura no ecommerce. O identificador da proposta é obrigatório para criar a assinatura.

Atributos para criação de assinatura

Campo	Tipo	Descrição	Obrigatório
identifier	string	Identificador único da proposta para criar a assinatura.	✓

Requisição

Body

{
    "identifier": "VAI403195"
}

Resposta de Sucesso

201

{
    "status": "success",
    "message": "Assinatura criada com sucesso",
    "document": [
        {
            "id": "sub_1RngMoJvvSEhYZkzxjLmnDXJ",
            "object": "subscription",
            "application": null,
            "application_fee_percent": null,
            "automatic_tax": {
                "disabled_reason": null,
                "enabled": false,
                "liability": null
            },
            "billing_cycle_anchor": 1753191386,
            "billing_cycle_anchor_config": null,
            "billing_mode": {
                "type": "classic"
            },
            "billing_thresholds": null,
            "cancel_at": null,
            "cancel_at_period_end": false,
            "canceled_at": null,
            "cancellation_details": {
                "comment": null,
                "feedback": null,
                "reason": null
            },
            "collection_method": "charge_automatically",
            "created": 1753191386,
            "currency": "brl",
            "customer": "cus_SimS1Y3azW0bVp",
            "days_until_due": null,
            "default_payment_method": "pm_1RnKuLJvvSEhYZkzuUHQGiAD",
            "default_source": null,
            "default_tax_rates": [],
            "description": null,
            "discounts": [],
            "ended_at": null,
            "invoice_settings": {
                "account_tax_ids": null,
                "issuer": {
                    "type": "self"
                }
            },
            "items": {
                "object": "list",
                "data": [
                    {
                        "id": "si_Sj8er0H2E9me9O",
                        "object": "subscription_item",
                        "billing_thresholds": null,
                        "created": 1753191386,
                        "current_period_end": 1755869786,
                        "current_period_start": 1753191386,
                        "discounts": [],
                        "metadata": {},
                        "plan": {
                            "id": "price_1RY5doJvvSEhYZkzmliPPb6H",
                            "object": "plan",
                            "active": true,
                            "amount": 4990,
                            "amount_decimal": "4990",
                            "billing_scheme": "per_unit",
                            "created": 1749475292,
                            "currency": "brl",
                            "interval": "month",
                            "interval_count": 1,
                            "livemode": false,
                            "metadata": {},
                            "meter": null,
                            "nickname": null,
                            "product": "prod_ST1hXf8mDzoImm",
                            "tiers_mode": null,
                            "transform_usage": null,
                            "trial_period_days": null,
                            "usage_type": "licensed"
                        },
                        "price": {
                            "id": "price_1RY5doJvvSEhYZkzmliPPb6H",
                            "object": "price",
                            "active": true,
                            "billing_scheme": "per_unit",
                            "created": 1749475292,
                            "currency": "brl",
                            "custom_unit_amount": null,
                            "livemode": false,
                            "lookup_key": null,
                            "metadata": {},
                            "nickname": null,
                            "product": "prod_ST1hXf8mDzoImm",
                            "recurring": {
                                "interval": "month",
                                "interval_count": 1,
                                "meter": null,
                                "trial_period_days": null,
                                "usage_type": "licensed"
                            },
                            "tax_behavior": "unspecified",
                            "tiers_mode": null,
                            "transform_quantity": null,
                            "type": "recurring",
                            "unit_amount": 4990,
                            "unit_amount_decimal": "4990"
                        },
                        "quantity": 1,
                        "subscription": "sub_1RngMoJvvSEhYZkzxjLmnDXJ",
                        "tax_rates": []
                    }
                ],
                "has_more": false,
                "total_count": 1,
                "url": "/v1/subscription_items?subscription=sub_1RngMoJvvSEhYZkzxjLmnDXJ"
            },
            "latest_invoice": "in_1RngMoJvvSEhYZkzlSpB7cfO",
            "livemode": false,
            "metadata": {},
            "next_pending_invoice_item_invoice": null,
            "on_behalf_of": null,
            "pause_collection": null,
            "payment_settings": {
                "payment_method_options": null,
                "payment_method_types": null,
                "save_default_payment_method": "on_subscription"
            },
            "pending_invoice_item_interval": null,
            "pending_setup_intent": null,
            "pending_update": null,
            "plan": {
                "id": "price_1RY5doJvvSEhYZkzmliPPb6H",
                "object": "plan",
                "active": true,
                "amount": 4990,
                "amount_decimal": "4990",
                "billing_scheme": "per_unit",
                "created": 1749475292,
                "currency": "brl",
                "interval": "month",
                "interval_count": 1,
                "livemode": false,
                "metadata": {},
                "meter": null,
                "nickname": null,
                "product": "prod_ST1hXf8mDzoImm",
                "tiers_mode": null,
                "transform_usage": null,
                "trial_period_days": null,
                "usage_type": "licensed"
            },
            "quantity": 1,
            "schedule": null,
            "start_date": 1753191386,
            "status": "active",
            "test_clock": null,
            "transfer_data": null,
            "trial_end": null,
            "trial_settings": {
                "end_behavior": {
                    "missing_payment_method": "create_invoice"
                }
            },
            "trial_start": null
        }
    ],
    "rowsAffected": []
}

Errors

Código	Referência	Explicação
400	BAD REQUEST	Assinatura já está ativa para este cliente e produto.
401	UNAUTHORIZED	O servidor não autorizou a requisição. Access Token inválido.
403	FORBIDDEN	O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso.
404	NOT FOUND	Proposta não encontrada com o identificador fornecido.
422	UNPROCESSABLE ENTITY	O servidor não conseguiu processar as informações contidas na requisição.

Exemplos de Respostas de Erro

404 - Proposta não encontrada

404

{
    "status": "error",
    "message": "Proposal not found (identifier)",
    "document": [],
    "rowsAffected": []
}

400 - Assinatura já existe

400

{
    "status": "error",
    "message": "Assinatura já está ativa para este cliente e produto",
    "document": [],
    "rowsAffected": []
}