Payment plan for recurring payments

It is essential to have payment plans for Recurring payments. We can edit our payment plans on https://billing.shoprenter.hu/plans. After logging in, you can see a list of our existing plans and add new ones.

Changing the price and name of the payment plan also affects existing subscriptions, if one of the two data is changed, the next fee payment period for existing subscriptions is based on the new data.

Payment plans list page:

Create a new payment plan:

Input	Description
Payment plan name	Here you can enter the name of the plan. Eg: "Bronze package of my application"
Length of payment cycles	Here you can specify at what intervals the amount requested for using the application should be deducted
Number of payment cycles	Here you can enter the number of times the shop owner's card will be debited
Net price of payment plan in HUF	The net price. For VAT calculation, see: Invoicing and VAT calculation

On the list page, we can refer to each Payment plan with the value in the Identifier column, when we want to create a Recurring fee payment through the API.

Example for recurring charge payment

API

Properties

Property	Description	Obligatory	Readable
id	Identity		x
name	Name (e.g.: Full Version, Monthly Gold package, etc.)	x	x
netPrice	Net price of payment plan in HUF	x	x
createdAt	Date of creation		x
updatedAt	Date of modification		x
billingCycleCount	Number of payment cycles		x
billingCycleLength	Length of payment cycles	x	x

Entry point

POST https://<shop_name>.api.myshoprenter.hu/billing/plans

Example payload:

{
    "name": "Gold package",
    "netPrice": 1000,
    "billingCycleLength": 5
    "billingCycleCount": 2
}

Response:

{
    "id": 22,
    "name": "Gold package",
    "netPrice": 1000,
    "createdAt": "2024-08-29 13:22:56",
    "updatedAt": "2024-08-29 13:22:56",
    "billingCycleCount": 2,
    "billingCycleLength": 5
}

GET https://<shop_name>.api.myshoprenter.hu/billing/plans

Response:

[
    {
        "id": 22,
        "name": "Gold package",
        "netPrice": 1000,
        "createdAt": "2024-08-29 13:22:56",
        "updatedAt": "2024-08-29 13:22:56",
        "billingCycleCount": null,
        "billingCycleLength": 5
    },
    {
        "id": 21,
        "name": "Silver package",
        "netPrice": 900,
        "createdAt": "2024-08-29 13:22:56",
        "updatedAt": "2024-08-29 13:22:56",
        "billingCycleCount": 1,
        "billingCycleLength": 5
    },
]

GET https://<shop_name>.api.myshoprenter.hu/billing/plans/22

Response:

    {
        "id": 22,
        "name": "Gold package",
        "netPrice": 1000,
        "createdAt": "2024-08-29 13:22:56",
        "updatedAt": "2024-08-29 13:22:56",
        "billingCycleCount": null,
        "billingCycleLength": 5
    }

PUT https://<shop_name>.api.myshoprenter.hu/billing/plans/22

Example payload:

{
    "name": "New Gold package",
    "netPrice": 1000,
    "billingCycleLength": 6
    "billingCycleCount": 2
}

Response:

[
    {
        "id": 22,
        "name": "Gold package",
        "netPrice": 1000,
        "createdAt": "2024-08-29 13:22:56",
        "updatedAt": "2024-08-29 13:35:56",
        "billingCycleCount": 2,
        "billingCycleLength": 6
    },
]

DELETE https://<shop_name>.api.myshoprenter.hu/billing/plans/22

Response status: 204