Sign in
Subscriptions

Creates a subscription proposal that must be authorized by the buyer

Authorization can be done through the feature v1/subscriptions/{subscription_id}/subscribe

post/v1/subscriptions/proposal

Request body

descriptionstring required

Brief description of what the signature refers to

reference_idstring required

Reference ID of your application VARCHAR(500)

expires_instring required

Deadline for signature authorization by the buyer

notification_urlstring required

URL that will receive a POST call when the transaction changes

Example request

{
  "reference_id": "my_subscription_728",
  "expires_in": "2026-10-01",
  "charge": {
    "start_date": "2026-10-01",
    "frequency": "MONTHLY",
    "duration": 1,
    "amount": 10000
  },
  "notification_url": "https://api.domain.com.br/v1/edubank-notification",
  "references": [
    {
      "due_date": "2026-10-01",
      "reference_id": "my_tuition_996"
    }
  ]
}

Response

The object has been successfully created

created_atstring

When the subscription was created. YYYY-MM-DDTHH:mm:ssZ

updated_atstring

Last time subscription was updated. YYYY-MM-DDTHH:mm:ssZ

seller_idstring required

Edubank seller id

subscription_idstring required

Edubank subscription id

descriptionstring required

Brief description of what the signature refers to

reference_idstring required

Reference ID of your application VARCHAR(500)

buyer_idstring required

Buyer id

status'PROPOSAL' | 'ACTIVE' | 'EXPIRED' | 'CANCELED' | 'SUSPENDED' | 'REACTIVATED' required

Subscription status: PROPOSAL - ACTIVE - CANCELED - SUSPENDED - REACTIVATED

expires_instring required

Deadline for signature authorization by the buyer

notification_urlstring required

URL that will receive a POST call when the transaction changes

Example response

{
  "created_at": "2026-10-01T23:59:59+00:00",
  "updated_at": "2026-10-01T23:59:59+00:00",
  "seller_id": "117a97d225337dmf96bb0b883a1019sj",
  "reference_id": "my_subscription_728",
  "buyer_id": "39c784f7bf754698aa078a261cf42439",
  "status": "PROPOSAL",
  "expires_in": "2026-10-01",
  "charge": {
    "start_date": "2026-10-01",
    "frequency": "MONTHLY",
    "duration": 1,
    "amount": 10000
  },
  "notification_url": "https://api.domain.com.br/v1/edubank-notification",
  "subscription_permission": {
    "authorized_in": "2026-10-01T23:59:59+00:00"
  },
  "references": [
    {
      "due_date": "2026-10-01",
      "reference_id": "my_tuition_996"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.