Get subscription plan

Check active subscription plans. No further payments will be collected.

Get subscription

Check a specific subscription plan.

GET https://api.stage.localpayment.com/api/subscriptions/plan/:externalId

View all subscription plans created by the customer.

GET https://api.stage.localpayment.com/api/subscriptions/plan

Path Parameters

Name	Type	Description
id*	string	Subscription plan Internal ID as returned by GET method

Headers

Name	Type	Description
Authorization*	string	JWT token in format Bearer eyJ0... . For more information about authentication, please refer to Authentication.

200 Get Subscription plan successfully.

{
    "internalId": "38a16a07-6616-4a90-82b9-0d7c8e2a2b76",
    "name": "Plan Básico Mensual",
    "description": "Acceso básico a contenido exclusivo",
    "amount": 100.0,
    "country": "ARG",
    "currency": "ARS",
    "accountNumber": "032.032.00000023",
    "autoRecurring": {
    "repetitions": 1,
    "type": "month"
 },
    "status": {
        "code": "100",
        "description": "ACTIVE",
        "detail": "Subscription plan is active"
    },
}

400 Could not find a matching subscription plan.

{
    "status": {
        "code": "400",
        "description": "ERROR",
        "detail": "Subscription not found"
    }
}

Curl: Example request

Curl --location --request PATCH 'https://api.stage.localpayment.com/api/subscriptions/plan/38a16a07-6616-4a90-82b9-0d7c8e2a2b76' \
header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ0b2tlbl90eXBlIjoiYWNjZXNzIiwiZXhwIjoxNjYyMDU1NTIxLCJqdGkiOiIxY2NhNjI2NTViZjg0ZDdlOWY1NWMxNmRmMGQzNzQxYyIsInVzZXJfaWQiOjIwLCJzdXBlcnVzZXIiOnRydWUsImlzX3N0YWZmIjp0cnVlLCJyb2xlcyI6WyJJU19BRE1JTiJdLCJjb3VudHJpZXMiOlsiQUxMIl0sImNvbXBhbnkiOiIwMDA1IiwiY2xpZW50X2NvZGUiOiIwMDA1In0.HW58M472NIdpATByTFe41f1311eHZlk7YhrwlHmczJs' \
header 'Content-Type: application/json' \
--data-raw '{
   }'

Example response: Status OK

{
    "internalId": "38a16a07-6616-4a90-82b9-0d7c8e2a2b76",
    "name": "Plan Básico Mensual",
    "description": "Acceso básico a contenido exclusivo",
    "amount": 100.0,
    "country": "ARG",
    "currency": "ARS",
    "accountNumber": "032.032.00000023",
    "autoRecurring": {
    "repetitions": 1,
    "type": "month"
 },
    "status": {
        "code": "100",
        "description": "ACTIVE",
        "detail": "Subscription plan is active"
    },
}