Subscription Plan | Subrite

Subscription Plan

Endpoints for Subscription Plan

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/subscription-plans

Authentication: Bearer token (JWT)

Parameters

Query parameters10

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderDirectionstringOptional
Default: "desc"Allowed values: "asc", "desc"
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt", "name"
statusstringOptional
Allowed values: "draft", "published", "archived"
allowSameSubscriptionChangebooleanOptional
allowDifferentSubscriptionSwitchbooleanOptional
showAsOptionOnSubscriptionSwitchbooleanOptional
showAsOptionOnAdminSubscriptionSwitchbooleanOptional
namestringOptional

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleSubscriptionPlanResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of SubscriptionPlanResponseRequired33 fields
items
- paymentProvidersarray of PAYMENT_PROVIDERRequired when parent is presentField path: items[].paymentProviders

Example requestcurl

curl

curl https://api.subrite.no/api/v1/subscription-plans \
  --header 'Authorization: Bearer <token>'

Try it

Create a new subscription plan#

POST/api/v1/subscription-plans

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaCreateSubscriptionPlanDto

18 top-level fieldsSelect an object to expand

productsarray of SubscriptionPlanProductDtoRequired3 required when the containing object is present3 fields
products
uniqueItems: true
- productIdnumberRequired when parent is present

GET/api/v1/subscription-plans/statistic

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleSubscriptionStatistic

4 top-level fields

activeMembersnumber

GET/api/v1/subscription-plans/all

Authentication: Bearer token (JWT)

Parameters

Query parameters6

statusstringOptional
Allowed values: "draft", "published", "archived"
allowSameSubscriptionChangebooleanOptional
allowDifferentSubscriptionSwitchbooleanOptional
showAsOptionOnSubscriptionSwitchbooleanOptional
showAsOptionOnAdminSubscriptionSwitchbooleanOptional
name

GET/api/v1/subscription-plans/enqueue-cleanup-invited-members-not-accepted-expired

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

This response has no body.

Responses 401

GET/api/v1/subscription-plans/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleSubscriptionPlanResponse

DELETE/api/v1/subscription-plans/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

This response has no body.

Responses 400

PATCH/api/v1/subscription-plans/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateSubscriptionPlanDto

18 top-level fieldsSelect an object to expand

productsarray of SubscriptionPlanProductDtoOptional3 required when the containing object is present

Schema ExampleSubscriptionPlanResponsePaginated

200 · application/json

{
  "items": [
    {
      "paymentProviders": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packages": [],
      "memberPackages": [],
      "metaData": {},
      "products": [],
      "tags": []
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 22 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

Query validation failed; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleSubscriptionPlanResponse

33 top-level fieldsSelect an object to expand

paymentProvidersarray of PAYMENT_PROVIDERRequired
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
namestringRequired
uuidstringRequired
billingPeriodstringRequired
Allowed values: "monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"
billingPeriodUnitstringRequired
Allowed values: "day", "week", "month", "year"
billingPeriodFrequencynumberRequired
autoRenewbooleanRequired
statusstringRequired
Allowed values: "draft", "published", "archived"
tenantIdnumberRequired
allowSameSubscriptionChangebooleanRequired
allowDifferentSubscriptionSwitchbooleanRequired
allowAdminSameSubscriptionChangebooleanRequired
allowAdminDifferentSubscriptionSwitchbooleanRequired
enableGiftSubscriptionbooleanRequired
allowFutureStartDatebooleanRequired
showAsOptionOnSubscriptionSwitchbooleanRequired
showAsOptionOnAdminSubscriptionSwitchbooleanRequired
offerSwitchOnCheckoutbooleanRequired
tenantTenantRequiredNested fields omitted: field limit.
entityTagsarray of EntityTagRequired13 fields
entityTags
- productIdnumberRequired when parent is presentField path: entityTags[].productId
- tagIdnumberRequired when parent is presentField path: entityTags[].tagId
- subscriptionPlanIdnumberRequired when parent is presentField path: entityTags[].subscriptionPlanId
- tagTagRequired when parent is presentField path: entityTags[].tagNested fields omitted: field limit.
- productProductRequired when parent is presentField path: entityTags[].productNested fields omitted: field limit.
subscriptionPlanProductsarray of SubscriptionPlanProductRequired13 fields
subscriptionPlanProducts
- subscriptionPlanIdnumberRequired when parent is presentField path: subscriptionPlanProducts[].subscriptionPlanId
- productIdnumberRequired when parent is presentField path: subscriptionPlanProducts[].productId
- pricenumberRequired when parent is presentField path: subscriptionPlanProducts[].price
- propertiesOptionalProductPropertiesRequired when parent is presentField path: subscriptionPlanProducts[].properties2 fields
packagesarray of PackageRequiredNested fields omitted: field limit.
memberPackagesarray of MemberPackageRequiredNested fields omitted: field limit.
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired
subscriptionCountnumberRequired
productsarray of SubscriptionProductRequired13 fields
products
- circulationTypeCIRCULATION_TYPEField path: products[].circulationType
  Can be nullAllowed values: "subscription", "single_copy"
- productIdnumberRequired when parent is presentField path: products[].productId
- namestringRequired when parent is presentField path: products[].name
- pricenumberRequired when parent is presentField path: products[].price
- currencystringRequired when parent is present
tagsarray of string
pricenumberRequired
hasOptionalProductsbooleanRequired

78 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleSubscriptionPlanResponse

201 · application/json

Responses 400

Status201 400 401 403 500application/json

Body validation failed, or a product id does not exist in this tenant; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError", "invalidProducts"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 lines

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/subscription-plans \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "products": [
    {}
  ],
  "paymentProviders": [
    "stripe"
  ],
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "allowAdminSameSubscriptionChange": true,
  "allowAdminDifferentSubscriptionSwitch": true,
  "enableGiftSubscription": true,
  "allowFutureStartDate": true,
  "showAsOptionOnSubscriptionSwitch": true,
  "showAsOptionOnAdminSubscriptionSwitch": true,
  "offerSwitchOnCheckout": true,
  "name": "string",
  "billingPeriod": "monthly",
  "billingPeriodUnit": "string",
  "billingPeriodFrequency": 1,
  "status": "draft",
  "autoRenew": true,
  "tags": [
    "string"
  ]
}'

Schema ExampleSubscriptionStatistic

200 · application/json

{
  "activeMembers": 0,
  "soldToday": 0,
  "soldYesterday": 0,
  "soldLast7Days": 0
}

Example · 6 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

string

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema Examplearray of SubscriptionPlanResponse

33 top-level fieldsSelect an object to expand

paymentProvidersarray of PAYMENT_PROVIDERRequired when parent is present
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
namestringRequired when parent is present
uuidstringRequired when parent is present
billingPeriodstringRequired when parent is present
Allowed values: "monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"
billingPeriodUnitstringRequired when parent is present
Allowed values: "day", "week", "month", "year"
billingPeriodFrequencynumberRequired when parent is present
autoRenewbooleanRequired when parent is present
statusstringRequired when parent is present
Allowed values: "draft", "published", "archived"
tenantIdnumberRequired when parent is present
allowSameSubscriptionChangebooleanRequired when parent is present
allowDifferentSubscriptionSwitchbooleanRequired when parent is present
allowAdminSameSubscriptionChangebooleanRequired when parent is present
allowAdminDifferentSubscriptionSwitchbooleanRequired when parent is present
enableGiftSubscriptionbooleanRequired when parent is present
allowFutureStartDatebooleanRequired when parent is present
showAsOptionOnSubscriptionSwitchbooleanRequired when parent is present
showAsOptionOnAdminSubscriptionSwitchbooleanRequired when parent is present
offerSwitchOnCheckoutbooleanRequired when parent is present
tenantTenantRequired when parent is presentNested fields omitted: field limit.
entityTagsarray of EntityTagRequired when parent is present13 fields
[].entityTags
- productIdnumberRequired when parent is presentField path: [].entityTags[].productId
- tagIdnumberRequired when parent is presentField path: [].entityTags[].tagId
- subscriptionPlanIdnumberRequired when parent is presentField path: [].entityTags[].subscriptionPlanId
- tagTagRequired when parent is presentField path: [].entityTags[].tagNested fields omitted: field limit.
- productProductRequired when parent is present
subscriptionPlanProductsarray of SubscriptionPlanProductRequired when parent is present13 fields
[].subscriptionPlanProducts
- subscriptionPlanIdnumberRequired when parent is presentField path: [].subscriptionPlanProducts[].subscriptionPlanId
- productIdnumberRequired when parent is presentField path: [].subscriptionPlanProducts[].productId
- pricenumberRequired when parent is presentField path: [].subscriptionPlanProducts[].price
- propertiesOptionalProductPropertiesRequired when parent is presentField path: [].subscriptionPlanProducts[].properties
packagesarray of PackageRequired when parent is presentNested fields omitted: field limit.
memberPackagesarray of MemberPackageRequired when parent is presentNested fields omitted: field limit.
idnumberRequired when parent is present
createdAtstring (date-time)Required when parent is present
updatedAtstring (date-time)Required when parent is present
deletedAtstring (date-time)Required when parent is present
metaDataobjectRequired when parent is present
subscriptionCountnumberRequired when parent is present
productsarray of SubscriptionProductRequired when parent is present13 fields
[].products
- circulationTypeCIRCULATION_TYPEField path: [].products[].circulationType
  Can be nullAllowed values: "subscription", "single_copy"
- productIdnumberRequired when parent is presentField path: [].products[].productId
- namestringRequired when parent is presentField path: [].products[].name
- pricenumberRequired when parent is presentField path: [].products[].price
- currencystring
tagsarray of string
pricenumberRequired when parent is present
hasOptionalProductsbooleanRequired when parent is present

78 documented fields · Scroll to see moreShow full heightShow compact view

Schema Examplearray of SubscriptionPlanResponse

200 · application/json

[
  {
    "paymentProviders": [],
    "name": "string",
    "uuid": "string",
    "billingPeriod": "monthly",
    "billingPeriodUnit": "day",
    "billingPeriodFrequency": 0,
    "autoRenew": true,
    "status": "draft",
    "tenantId": 0,
    "allowSameSubscriptionChange": true,
    "allowDifferentSubscriptionSwitch": true,
    "allowAdminSameSubscriptionChange": true,
    "allowAdminDifferentSubscriptionSwitch": true,
    "enableGiftSubscription": true,
    "allowFutureStartDate": true,
    "showAsOptionOnSubscriptionSwitch": true,
    "showAsOptionOnAdminSubscriptionSwitch": true,
    "offerSwitchOnCheckout": true,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "entityTags": [],
    "subscriptionPlanProducts": [],
    "packages": [],
    "memberPackages": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {},
    "subscriptionCount": 0,
    "products": [],
    "tags": [],
    "price": 0,
    "hasOptionalProducts": true
  }
]

Responses 400

Status200 400 401 403 500application/json

Query validation failed; field codes in errors[]

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleSubscriptionPlanResponse

200 · application/json

{
  "paymentProviders": [
    "stripe"
  ],
  "name": "string",
  "uuid": "string",
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "autoRenew": true,
  "status": "draft",
  "tenantId": 0,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "allowAdminSameSubscriptionChange": true,
  "allowAdminDifferentSubscriptionSwitch": true,
  "enableGiftSubscription": true,
  "allowFutureStartDate": true,
  "showAsOptionOnSubscriptionSwitch": true,
  "showAsOptionOnAdminSubscriptionSwitch": true,
  "offerSwitchOnCheckout": true,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "entityTags": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlanProducts": [
    {
      "metaData": {}
    }
  ],
  "packages": [
    {
      "paymentProviders": [],
      "description": {},
      "packageProducts": [],
      "payments": [],
      "memberPackages": [],
      "metaData": {}
    }
  ],
  "memberPackages": [
    {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {},
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "tags": [
    "string"
  ],
  "price": 0,
  "hasOptionalProducts": true
}

Example · 147 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The id is not an integer

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

subscriptionPlanNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "subscriptionPlanNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "subscriptionPlanNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "subscriptionPlanUsedInPackages"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

subscriptionPlanNotFound

Schema ExampleErrorResponse

Same fields as Get a subscription plan by id (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "subscriptionPlanNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleUpdateSubscriptionPlanDto

application/json

{
  "paymentProviders": [
    "stripe"
  ],
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "allowAdminSameSubscriptionChange": true,
  "allowAdminDifferentSubscriptionSwitch": true,
  "enableGiftSubscription": true,
  "allowFutureStartDate": true,
  "showAsOptionOnSubscriptionSwitch": true,
  "showAsOptionOnAdminSubscriptionSwitch": true,
  "offerSwitchOnCheckout": true,
  "name": "string",
  "billingPeriod": "monthly",
  "billingPeriodUnit": "string",
  "billingPeriodFrequency": 1,
  "status": "draft",
  "autoRenew": true,
  "tags": [
    "string"
  ]
}

Example · 23 linesShow full heightShow compact view

Responses

7 status codes

Responses 200

Status200 400 401 403 404 500 503application/json

Schema ExampleSubscriptionPlanResponse

Same fields as Create a new subscription plan (201).

Schema ExampleSubscriptionPlanResponse

200 · application/json

{
  "paymentProviders": [
    "stripe"
  ],
  "name": "string",
  "uuid": "string",
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "autoRenew": true,
  "status": "draft",
  "tenantId": 0,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "allowAdminSameSubscriptionChange": true,
  "allowAdminDifferentSubscriptionSwitch": true,
  "enableGiftSubscription": true,
  "allowFutureStartDate": true,
  "showAsOptionOnSubscriptionSwitch": true,
  "showAsOptionOnAdminSubscriptionSwitch": true,
  "offerSwitchOnCheckout": true,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "entityTags": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlanProducts": [
    {
      "metaData": {}
    }
  ],
  "packages": [
    {
      "paymentProviders": [],
      "description": {},
      "packageProducts": [],
      "payments": [],
      "memberPackages": [],
      "metaData": {}
    }
  ],
  "memberPackages": [
    {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {},
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "tags": [
    "string"
  ],
  "price": 0,
  "hasOptionalProducts": true
}

Example · 147 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500 503application/json

Body validation failed, the id is not an integer, a product id is unknown, or the product change is not allowed while members are subscribed to the plan

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError", "invalidProducts", "planProductRemovalBlockedByActiveSubscriptions", "planRequiredProductAdditionBlockedByActiveSubscriptions"

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 500 503application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 500 503application/json

subscriptionPlanNotFound

Schema ExampleErrorResponse

Same fields as Get a subscription plan by id (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 400 401 403 404 500 503application/json

internalServerError

SchemaErrorResponse

Same fields as Get all subscription plans of the tenant (403).

Responses 503

Status200 400 401 403 404 500 503application/json

The price change could not be queued for the affected subscriptions; nothing was saved

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "subscriptionPlanPropagationFailed"
messagestring

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/subscription-plans/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "products": [
    {}
  ],
  "paymentProviders": [
    "stripe"
  ],
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "allowAdminSameSubscriptionChange": true,
  "allowAdminDifferentSubscriptionSwitch": true,
  "enableGiftSubscription": true,
  "allowFutureStartDate": true,
  "showAsOptionOnSubscriptionSwitch": true,
  "showAsOptionOnAdminSubscriptionSwitch": true,
  "offerSwitchOnCheckout": true,
  "name": "string",
  "billingPeriod": "monthly",
  "billingPeriodUnit": "string",
  "billingPeriodFrequency": 1,
  "status": "draft",
  "autoRenew": true,
  "tags": [
    "string"
  ]
}'

{
  "paymentProviders": [
    "stripe"
  ],
  "name": "string",
  "uuid": "string",
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "autoRenew": true,
  "status": "draft",
  "tenantId": 0,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "allowAdminSameSubscriptionChange": true,
  "allowAdminDifferentSubscriptionSwitch": true,
  "enableGiftSubscription": true,
  "allowFutureStartDate": true,
  "showAsOptionOnSubscriptionSwitch": true,
  "showAsOptionOnAdminSubscriptionSwitch": true,
  "offerSwitchOnCheckout": true,
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "entityTags": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlanProducts": [
    {
      "metaData": {}
    }
  ],
  "packages": [
    {
      "paymentProviders": [],
      "description": {},
      "packageProducts": [],
      "payments": [],
      "memberPackages": [],
      "metaData": {}
    }
  ],
  "memberPackages": [
    {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    }
  ],
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {},
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "tags": [
    "string"
  ],
  "price": 0,
  "hasOptionalProducts": true
}

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

{
  "messageCode": "subscriptionPlanNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Schema ExampleErrorResponse

503 · application/json

{
  "messageCode": "subscriptionPlanPropagationFailed",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Get all subscription plans of the tenant#

Parameters

Responses

Responses 200

Create a new subscription plan#

Request body

Get statistic of subscription plans#

Responses

Responses 200

Get subscription plans by filters#

Parameters

Enqueue cleanup invited members not accepted expired#

Responses

Responses 200

Responses 401

Get a subscription plan by id#

Parameters

Responses

Responses 200

Delete a subscription plan#

Parameters

Responses

Responses 200

Responses 400

Update a subscription plan#

Parameters

Request body

Get all subscription plans of the tenant#

Parameters

Responses

Responses 200

Create a new subscription plan#

Request body

Get statistic of subscription plans#

Responses

Responses 200

Get subscription plans by filters#

Parameters

Enqueue cleanup invited members not accepted expired#

Responses

Responses 200

Responses 401

Get a subscription plan by id#

Parameters

Responses

Responses 200

Delete a subscription plan#

Parameters

Responses

Responses 200

Responses 400

Update a subscription plan#

Parameters

Request body

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 201

Responses 400

Responses 401

Responses 403

Responses 500

Responses 401

Responses 403

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Responses 403

Responses 500

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500