Get a subscription by code.

Request

Authorization

Add parameter in header

Company-Token

Example:

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

Path Params

code

string

required

Header Params

Accept

string

optional

Example:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://api.test.apipagos.com/api/v2/apipagos/subscriptions/' \
--header 'Accept: application/json' \
--header 'Company-Token;'

Responses

🟢200OK

application/json

Body

data

object (Subscription)

optional

code

string

required

config_code

string

required

gateway_code

string

required

user_payment_method

object | null

required

status

object (System Status)

required

integrity_code

string

required

debit_day

integer <uint32>

required

start_date

string <date-time>

required

user

object (User)

required

document_type

object (Document Type)

required

field_1

string | null

required

field_2

string | null

required

field_3

string | null

required

reference_1

string | null

required

reference_2

string | null

required

created_at

string <date-time>

required

Timestamp de creacion

updated_at

string <date-time>

required

Timestamp de última actualizacion

Example

{
  "data": {
    "code": "<string>",
    "config_code": "<string>",
    "created_at": "<dateTime>",
    "debit_day": "<integer>",
    "document_type": {
      "config": "<string>",
      "created_at": "<dateTime>",
      "description": "<string>",
      "documents_source": "<string>",
      "program_type": "<string>",
      "status": {
        "action": "showHelp",
        "code": "<integer>",
        "description": "<string>",
        "label": "<string>"
      },
      "title": "<string>",
      "transactions_source": "<string>",
      "type_code": "<string>",
      "updated_at": "<dateTime>"
    },
    "field_1": "<string>",
    "field_2": "<string>",
    "field_3": "<string>",
    "gateway_code": "<string>",
    "id": "<integer>",
    "integrity_code": "<string>",
    "reference_1": "<string>",
    "reference_2": "<string>",
    "start_date": "<dateTime>",
    "status": {
      "action": "showHelp",
      "code": "<integer>",
      "description": "<string>",
      "label": "<string>"
    },
    "updated_at": "<dateTime>",
    "user": {
      "birth_country": "<string>",
      "birthdate": "<dateTime>",
      "code": "<string>",
      "company_id": "<integer>",
      "correlation_id": "<string>",
      "created_at": "<dateTime>",
      "email": "<string>",
      "email_verified_at": "<dateTime>",
      "field_1": "<string>",
      "field_2": "<string>",
      "field_3": "<string>",
      "first_name": "<string>",
      "gender": "Male",
      "id": "<integer>",
      "last_name": "<string>",
      "marital_status": "Widowed",
      "nationality": "<string>",
      "profile_photo_url": "<string>",
      "status": {
        "action": "none",
        "code": "<integer>",
        "description": "<string>",
        "label": "<string>"
      },
      "type": "f",
      "updated_at": "<dateTime>"
    },
    "user_payment_method": {
      "bin": "<string>",
      "code": "<string>",
      "created_at": "<dateTime>",
      "csv": "<string>",
      "due_date": "<string>",
      "entity_code": "<string>",
      "method": "CBU",
      "name": "<string>",
      "number": "<string>",
      "updated_at": "<dateTime>",
      "visible_data": "<string>"
    }
  }
}

🔴500Server Error Response