Subscription status

This method get the current state of a automatic payment subscription.

SecurityApi-Key
Request
path Parameters
id
required
string <= 255 characters

unique identifier of a subscription.

Responses
200

Successful operation. Returns a JSON object with the subscription id information.

Response Schema: application/json
subscription_id
required
string <= 255 characters

Unique subscription identifier.

Example: "13a0f1aa-5e47-4894-aa8b-282dd19593ec"
status
required
string

The current status of the subscription. A charge intent can only be made if the status is ENABLED.

Enum: "DISABLED" "SIGNED" "ENABLED"
Example: "SIGNED"
developer
required
boolean

Indicates if the subscription was created using the sandbox environment. A false value means that is a production subscription.

Example: false
customer_bank_code
required
string <= 255 characters

The bank used by the customer to sign the subscription. The possible values are the ones used in the Khipu Payment API, or no-bank if the subscription has not been signed.

Example: "8"
service_reference
required
string <= 255 characters

The alias used to identify the subscription.

Example: "My Merchant name"
400

Bad Request

401

Unauthorized - Invalid or missing credentials

404

Not found - Resource not available

500

Remote service error :(

get/v1/automatic-payment/subscription/{id}
Request samples 
Response samples 
application/json
{
  • "subscription_id": "13a0f1aa-5e47-4894-aa8b-282dd19593ec",
  • "status": "SIGNED",
  • "developer": false,
  • "customer_bank_code": "8",
  • "service_reference": "My Merchant name"
}