Subscription

Create subscriptions for KLARA tenants.

A KLARA user might have multiple subscriptions. Each subscription will enable a set of feature inside KLARA platform. This endpoint allows to create subscriptions for a KLARA tenant. <p>Each subscription is subjective to its own terms and conditions. Please ask your KLARA contacts or see more details using the KLARA webclient.</p>

post/core/latest/subscriptions

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/core/latest/subscriptions
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Query parameters

marketing-codestring[]

Marketing code to identify which product will be subscribed. The marketing codes to create subscriptions for.

Response

Subscription created successfully

marketingCodesstring[] required

Marketing code to identify which product will be subscribed.

pricePlan'SINGLE' | 'VOLUME' | 'MONTHLY' | 'QUARTERLY' | 'YEARLY' | 'FREE' | 'PAY_PER_USE'

Specify how the subscription is paid. The full set of accepted values is the PricePlan schema. <br><ul><li> SINGLE: Pay once for the whole subscription period. </li><li> VOLUME: Pay once for the whole subscription period and pay for each volume. </li><li> MONTHLY: Pay monthly for the subscription period. </li><li> QUARTERLY: Pay quarterly for the subscription period. </li><li> YEARLY: Pay yearly for the subscription period. </li><li> FREE: Free subscription. </li><li> PAY_PER_USE: Pay for each usage. </li></ul>

pricenumber

The price of this subscription at this moment

subscriptionFromstring date-time

Specify when the subscription will start effectively. By default, the start date is today

subscriptionUntilstring date-time

Specify when the subscription will end effectively after unsubscribe. This value will be calculated by service itself.

renewalDatestring date

Indicates the date that subscription will automatically renewed for another period if no cancellation is made before this date.

Example response

[
  {
    "product": {
      "code": "PRINTANDSENT",
      "name": "Print and sent"
    },
    "pricePlan": "MONTHLY",
    "price": 10,
    "subscriptionFrom": "2023-11-20 T10:15:30",
    "subscriptionUntil": "2024-11-20 T10:15:30",
    "renewalDate": "2024-20-11"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.