Subscriptions

Returns the account's subscription templates (deleted ones are never listed), ordered by the template's display order, 250 per page.

Each row includes: abon_id, name (the name used on invoices), public_name (the public label; equals name when no public name is set), description, price_ex_tva, price_w_tva, vat_percent, currency, period_in_months, um, group, is_published (1 = published for online ordering). With raises_limit, each row also carries limit_increase.

Filters (URL path segments):
- published:1 only published templates, published:0 only unpublished ones. Omit it to list both.
- raises_limit:{limit_key} only published templates that raise the given account limit and are offered for it. Implies published:1.
- cached:1 serve from a 1 hour server-side cache. Honoured only together with raises_limit alone on page 1; ignored otherwise. The activations include is never served from cache.
- include:activations (BOCP vendor account only; ignored on any other account) adds an activations object to each row: modules [{id, code, title}], submodules [{id, code, name}], pilots [{id, text_id, name, is_free, job_description}] and limits {limit_key: integer}.
- Standard: id, minid, page.

An empty result returns 404.

Responses

BOCP vendor account only. Computes what a client would pay to start a subscription template now and have it renew together with the client's existing subscription.

The reference subscription is the client's active, auto-renewed, non-expired, paid subscription for the given BOCP account, in the template's currency, with the earliest next invoicing date on or after today. The first period runs from today to that date (end_date, exclusive): as many whole periods of period_months as fit, counted backwards from end_date, plus the remaining days, priced per day as monthly price × discount / days in the current month. Discount: 6 months 5%, 12 months 10%.

Filters (URL path segments):
- abon_tpl_id:{id} required, the template.
- for_client_id:{id} required, the client contact; must be the billing contact of for_account_id.
- for_account_id:{id} required, the client's BOCP account.
- abon_units:{n} optional, 1 to 100, default 1.

Response fields: available (0/1), end_date, period_months, reference_name, days, whole_periods, partial_amount_ex_tva, amount_ex_tva, amount_w_vat, unit_price_ex_tva (discounted monthly price for future renewals). When available is 0 the reason is in messages. Templates invoiced on a fixed day of the month are never aligned.

Responses

Returns the details of one subscription template: name, public_name (falls back to name), description, price with/without VAT, period in months, currency, unit, group, VAT %.

include:activations (BOCP vendor account only) adds the same activations object as the list.

include:detailed_description adds detailed_description: the HTML offer presentation of the template (tags p, ul, ol, li, strong, em, a, h3). It is filled only for orderable templates (published, or on the BOCP vendor account the activation template of a submodule or pilot); for any other template it is an empty string. Never cached. Treat it as untrusted HTML and sanitize before rendering.

Parameters

Responses