Create new subscriptions.

Request

Authorization

Add parameter in header

Company-Token

Example:

Company-Token: ********************

Header Params

string

optional

Example:

application/json

Body Params application/json

array of:

debit_day

string | null

optional

field_1

string | null

optional

field_2

string | null

optional

field_3

string | null

optional

reference_1

string | null

optional

reference_2

string | null

optional

start_date

string | null

optional

status_code

integer | null

optional

subscription_type_id

string

required

token

string

optional

paymentInfo

object

required

number

string

required

due_date

string

optional

name

string

optional

csv

string

optional

Example

[
  {
    "debit_day": "2025-11-08",
    "field_1": null,
    "field_2": null,
    "field_3": "eiusmod voluptate adipisicing",
    "reference_1": null,
    "reference_2": null,
    "start_date": "2026-01-04",
    "status_code": 3,
    "subscription_type_id": "dolor deserunt Duis sunt minim",
    "token": "in adipisicing",
    "paymentInfo": {
      "number": "15",
      "due_date": "2025-04-08",
      "name": "Laura Espinosa de los Monteros Delgadillo",
      "csv": "ut in"
    }
  },
  {
    "debit_day": "2025-09-26",
    "field_1": null,
    "field_2": null,
    "field_3": null,
    "reference_1": "eu pariatur non et eiusmod",
    "reference_2": null,
    "start_date": "2026-02-22",
    "status_code": 61,
    "subscription_type_id": "quis proident velit",
    "token": "aliquip tempor occaecat",
    "paymentInfo": {
      "number": "82",
      "due_date": "2024-10-22",
      "name": "Jennifer Arroyo Melgar",
      "csv": "deserunt cillum amet nostrud"
    }
  },
  {
    "debit_day": "2025-09-18",
    "field_1": "cupidatat magna",
    "field_2": null,
    "field_3": "dolore commodo ea",
    "reference_1": "aliqua id fugiat aliquip consequat",
    "reference_2": null,
    "start_date": "2025-08-19",
    "status_code": 9,
    "subscription_type_id": "officia labore",
    "token": "nostrud dolore ea",
    "paymentInfo": {
      "number": "36",
      "due_date": "2025-08-29",
      "name": "Maica León Granados",
      "csv": "Lorem aute anim consequat in"
    }
  }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.test.apipagos.com/api/v2/apipagos/subscriptions' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '[
    {
        "debit_day": "2025-11-08",
        "field_1": null,
        "field_2": null,
        "field_3": "eiusmod voluptate adipisicing",
        "reference_1": null,
        "reference_2": null,
        "start_date": "2026-01-04",
        "status_code": 3,
        "subscription_type_id": "dolor deserunt Duis sunt minim",
        "token": "in adipisicing",
        "paymentInfo": {
            "number": "15",
            "due_date": "2025-04-08",
            "name": "Laura Espinosa de los Monteros Delgadillo",
            "csv": "ut in"
        }
    },
    {
        "debit_day": "2025-09-26",
        "field_1": null,
        "field_2": null,
        "field_3": null,
        "reference_1": "eu pariatur non et eiusmod",
        "reference_2": null,
        "start_date": "2026-02-22",
        "status_code": 61,
        "subscription_type_id": "quis proident velit",
        "token": "aliquip tempor occaecat",
        "paymentInfo": {
            "number": "82",
            "due_date": "2024-10-22",
            "name": "Jennifer Arroyo Melgar",
            "csv": "deserunt cillum amet nostrud"
        }
    },
    {
        "debit_day": "2025-09-18",
        "field_1": "cupidatat magna",
        "field_2": null,
        "field_3": "dolore commodo ea",
        "reference_1": "aliqua id fugiat aliquip consequat",
        "reference_2": null,
        "start_date": "2025-08-19",
        "status_code": 9,
        "subscription_type_id": "officia labore",
        "token": "nostrud dolore ea",
        "paymentInfo": {
            "number": "36",
            "due_date": "2025-08-29",
            "name": "Maica León Granados",
            "csv": "Lorem aute anim consequat in"
        }
    }
]'

Responses

🟢200OK

application/json

Body

data

array [object {15}]

required

code

string

optional

config_code

string

optional

gateway

string

optional

user_payment_method

object

optional

integrity_code

string

optional

debit_day

string

optional

start_date

string

optional

field_1

string

optional

field_2

string

optional

field_3

string

optional

reference_1

string

optional

reference_2

string

optional

created_at

string

optional

updated_at

string

optional

canceled_at

string

optional

Example

{
  "data": [
    {
      "code": "string",
      "config_code": "string",
      "gateway": "string",
      "user_payment_method": {
        "entity_id": "null",
        "entity_code": "null",
        "code": "string",
        "company_id": "number",
        "user_id": "null",
        "holder": "null",
        "field_1": "null",
        "method": "string",
        "gateway_code": "string",
        "gateway_type": "string",
        "number": "encrypted_string",
        "hashed_number": "hashed_string",
        "visible_data": "masked_string",
        "bin": "string",
        "due_date": "string (MM/YY)",
        "name": "string",
        "csv": "string",
        "created_at": "datetime (ISO 8601)",
        "updated_at": "datetime (ISO 8601)",
        "deleted_at": "null"
      },
      "integrity_code": "null",
      "debit_day": "number",
      "start_date": "datetime (YYYY-MM-DD HH:mm:ss)",
      "field_1": "null",
      "field_2": "null",
      "field_3": "string",
      "reference_1": "null",
      "reference_2": "string",
      "created_at": "datetime (ISO 8601)",
      "updated_at": "datetime (ISO 8601)",
      "canceled_at": "null"
    }
  ]
}

🔴500Server Error Response