- Apipagos Extras
- Apipagos Core
- Contracts
- Documents
- Refunds
- Subscriptions
- Transactions
- Publications
- Users
- Location
- Tenant infoGET
- AFIPGET
Update Single Subscription
Developing
Testing Env
Testing Env
PATCH
/subscriptions/{value}
Request
Authorization
Add parameter in header
Company-Token
Example:
Company-Token: ********************
Path Params
value
string
required
Example:
id_gateway = 30 / code = 1cb1e2ccf5592c47c870a58a6d1027b6
Body Params application/json
array of:
status_code
integer
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
auditor
string
optional
integrity_code
string
optional
visible_dat
string
optional
Example
[
{
"status_code": 76,
"debit_day": "2026-03-25",
"start_date": "2024-10-26",
"field_1": "pariatur eu anim",
"field_2": "exercitation irure consequat in",
"field_3": "dolore est ipsum esse",
"reference_1": "anim labore ad",
"reference_2": "ex fugiat mollit dolor",
"auditor": "Lorem",
"integrity_code": "6",
"visible_dat": "2025-04-21T18:12:45.943Z"
},
{
"status_code": 84,
"debit_day": "2026-03-08",
"start_date": "2024-05-11",
"field_1": "incididunt sit commodo ea",
"field_2": "laborum esse",
"field_3": "id",
"reference_1": "voluptate dolor",
"reference_2": "in exercitation aute ut nisi",
"auditor": "cillum ea sed",
"integrity_code": "39",
"visible_dat": "2025-04-22T06:15:36.656Z"
},
{
"status_code": 47,
"debit_day": "2026-03-31",
"start_date": "2025-10-07",
"field_1": "elit dolor quis",
"field_2": "nostrud adipisicing",
"field_3": "tempor velit",
"reference_1": "nisi velit consectetur",
"reference_2": "officia in enim esse cillum",
"auditor": "ipsum cillum labore",
"integrity_code": "53",
"visible_dat": "2025-04-22T01:45:08.959Z"
}
]
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PATCH 'https://api.test.apipagos.com/api/v2/apipagos/subscriptions/id_gateway = 30 / code = 1cb1e2ccf5592c47c870a58a6d1027b6' \
--header 'Content-Type: application/json' \
--header 'Company-Token;' \
--data-raw '[
{
"status_code": 76,
"debit_day": "2026-03-25",
"start_date": "2024-10-26",
"field_1": "pariatur eu anim",
"field_2": "exercitation irure consequat in",
"field_3": "dolore est ipsum esse",
"reference_1": "anim labore ad",
"reference_2": "ex fugiat mollit dolor",
"auditor": "Lorem",
"integrity_code": "6",
"visible_dat": "2025-04-21T18:12:45.943Z"
},
{
"status_code": 84,
"debit_day": "2026-03-08",
"start_date": "2024-05-11",
"field_1": "incididunt sit commodo ea",
"field_2": "laborum esse",
"field_3": "id",
"reference_1": "voluptate dolor",
"reference_2": "in exercitation aute ut nisi",
"auditor": "cillum ea sed",
"integrity_code": "39",
"visible_dat": "2025-04-22T06:15:36.656Z"
},
{
"status_code": 47,
"debit_day": "2026-03-31",
"start_date": "2025-10-07",
"field_1": "elit dolor quis",
"field_2": "nostrud adipisicing",
"field_3": "tempor velit",
"reference_1": "nisi velit consectetur",
"reference_2": "officia in enim esse cillum",
"auditor": "ipsum cillum labore",
"integrity_code": "53",
"visible_dat": "2025-04-22T01:45:08.959Z"
}
]'
Responses
🟢200Success
application/json
Body
data
object
required
id
integer
required
company_id
integer
required
code
string
required
subscription_type_id
string
required
subscription_type
string
required
gateway_id
string
required
gateway_code
string
required
user_payment_method_id
integer
required
token
string
required
visible_data
string
required
status_code
integer
required
integrity_code
string
required
debit_day
integer
required
start_date
string
required
user_id
integer
required
document_type_code
string
required
field_1
string
required
field_2
string
required
field_3
string
required
reference_1
string
required
reference_2
string
required
auditor
string
required
canceled_at
string
required
updated_at
string
required
deleted_at
string
required
status
object
required
document_type
object
required
gateway
object
required
user
object
required
payment_method
object
required
metadata
object
required
Example
{
"data": {
"id": "integer",
"company_id": "integer",
"code": "string",
"subscription_type_id": "null",
"subscription_type": "null",
"gateway_id": "integer",
"gateway_code": "string",
"user_payment_method_id": "integer",
"token": "string",
"visible_data": "null",
"status_code": "integer",
"integrity_code": "null",
"debit_day": "integer",
"start_date": "string (date-time)",
"user_id": "integer",
"document_type_code": "string",
"field_1": "null",
"field_2": "null",
"field_3": "null",
"reference_1": "null",
"reference_2": "null",
"auditor": "string",
"canceled_at": "null",
"created_at": "string (date-time)",
"updated_at": "string (date-time)",
"deleted_at": "null",
"status": {
"id": "integer",
"model_type": "string",
"action": "string",
"label": "string",
"description": "string",
"help_id": "null",
"code": "integer",
"deleted_at": "null",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
},
"document_type": {
"id": "integer",
"company_id": "integer",
"transactions_table_id": "integer",
"documents_table_id": "integer",
"type_code": "string",
"form_id": "null",
"title": "string",
"description": "string",
"documents_source": "string",
"transactions_source": "string",
"help_id": "integer",
"status_code": "integer",
"template_id": "integer",
"program_type": "string",
"auditor": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)",
"deleted_at": "null"
},
"gateway": {
"id": "integer",
"company_id": "integer",
"wallet_id": "integer",
"gateway_code": "string",
"type": "string",
"status_code": "integer",
"z_index": "integer",
"title": "string",
"description": "string",
"status_message": "string",
"info_message": "string",
"error_message": "string",
"success_message": "string",
"min_amount": "string",
"max_amount": "string",
"settlement_days": "integer",
"settlement_prefix": "string",
"settlement_suffix": "string",
"config": "string (JSON)",
"connector_config": "string (JSON)",
"publication_config": "string (JSON)",
"callback_url": "string",
"entity_code": "string",
"help_id": "integer",
"client_accounting_account": "string",
"client_entity_account": "string",
"erp_accounting_account": "string",
"default": "integer",
"correlation_number": "integer",
"auditor": "string",
"created_at": "string (date-time)",
"updated_at": "string (date-time)",
"deleted_at": "null"
},
"user": {
"id": "integer",
"code": "string",
"correlation_id": "null",
"company_id": "integer",
"process_id": "null",
"type": "string",
"email": "string",
"first_name": "string",
"last_name": "string",
"company_name": "null",
"field_1": "string",
"field_2": "string",
"field_3": "string",
"profile_photo_url": "null",
"birthdate": "string (date)",
"birth_country": "string",
"birth_country_id": "integer",
"nationality": "string",
"nationality_id": "integer",
"gender": "string",
"marital_status": "string",
"status_code": "integer",
"integrity_code": "null",
"auditor": "string",
"deleted_at": "null",
"updated_at": "string (date-time)",
"created_at": "string (date-time)",
"email_verified_at": "null",
"status": {
"id": "integer",
"model_type": "string",
"action": "string",
"label": "string",
"description": "string",
"help_id": "null",
"code": "integer",
"deleted_at": "null",
"created_at": "string (date-time)",
"updated_at": "string (date-time)"
}
},
"payment_method": {
"id": "integer",
"entity_id": "integer",
"entity_code": "string",
"code": "string",
"company_id": "integer",
"user_id": "integer",
"holder": "null",
"field_1": "null",
"method": "string",
"gateway_code": "string",
"gateway_type": "string",
"number": "string",
"hashed_number": "null",
"visible_data": "string",
"bin": "null",
"due_date": "null",
"name": "null",
"csv": "null",
"created_at": "string (date-time)",
"updated_at": "string (date-time)",
"deleted_at": "null"
}
},
"metadata": {
"message": "Subscription updated succesfully!"
}
}
🔴500Server Error Response
Modified at 2025-04-22 14:03:26