Product Package | Subrite

Product Package

Endpoints for Product Package

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/product-packages

Authentication: Bearer token (JWT)

Parameters

Query parameters19

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", "status", "recurringPrice", "price"
statusarray of stringOptional
Filter by one or more statusesAllowed values: "draft", "published", "archived"
billingPeriodarray of stringOptional
Filter by one or more billing periods (subscription duration filter)Allowed values: "monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"
recurringPriceMinnumberOptional
Minimum recurring price (inclusive). Derived from package subscription products.minimum: 0
recurringPriceMaxnumberOptional
Maximum recurring price (inclusive). Derived from package subscription products.minimum: 0
priceMinnumberOptional
Minimum intro price (inclusive). Derived from package products.minimum: 0
priceMaxnumberOptional
Maximum intro price (inclusive). Derived from package products.minimum: 0
createdAtFromstringOptional
Created at from date (inclusive, ISO date). Filters package.createdAt.
createdAtTostringOptional
Created at to date (inclusive, ISO date). Filters package.createdAt.
updatedAtFromstringOptional
Updated at from date (inclusive, ISO date). Filters package.updatedAt.
updatedAtTostringOptional
Updated at to date (inclusive, ISO date). Filters package.updatedAt.
isAvailableViaSlugbooleanOptional
isAvailableOnMyPagebooleanOptional
isAvailableForManualOrderViaAdminbooleanOptional
enableGiftSubscriptionbooleanOptional
namestringOptional

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExamplePackageResponsePaginated

2 top-level fieldsSelect an object to expand

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

Example requestcurl

curl

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

Try it

Create a new package#

POST/api/v1/product-packages

Authentication: Bearer token (JWT)

Request body

Required bodymultipart/form-data

SchemaCreatePackageDto

23 top-level fieldsSelect an object to expand

salesTitlestringRequired
slugstringOptional
subscriptionPlanIdnumberOptional
minimum: 1

GET/api/v1/product-packages/free

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of MinimalPackageResponse

4 top-level fields

packNamestringRequired when parent is present

GET/api/v1/product-packages/manual-order

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema Examplearray of MinimalPackageResponse

4 top-level fields

GET/api/v1/product-packages/all

Authentication: Bearer token (JWT)

Parameters

Query parameters15

statusarray of stringOptional
Filter by one or more statusesAllowed values: "draft", "published", "archived"
billingPeriodarray of stringOptional
Filter by one or more billing periods (subscription duration filter)Allowed values: "monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"
recurringPriceMinnumberOptional
Minimum recurring price (inclusive). Derived from package subscription products.minimum: 0

GET/api/v1/product-packages/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExamplePackageResponse

Same fields as Create a new package (201).

DELETE/api/v1/product-packages/{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/product-packages/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodymultipart/form-data

SchemaUpdatePackageDto

25 top-level fieldsSelect an object to expand

salesTitlestringOptional
slugstringOptional

GET/api/v1/product-packages/slug/{tenantId}/{slug}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

tenantIdnumberRequired
slugstringRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

GET/api/v1/product-packages/id/{tenantId}/{id}/slug

Authentication: Bearer token (JWT)

Parameters

Path parameters2

tenantIdnumberRequired
idnumberRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

PATCH/api/v1/product-packages/display-order/all

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema Examplearray of UpdatePackageDisplayOrderRequestDto

2 top-level fields

idnumberRequired when parent is present
displayOrdernumberRequired when parent is present
The order in which the package should appear on mypage:

Get introductory & recurring price by quantity of optional products#

POST/api/v1/product-packages/price-by-quantity

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaPriceByQuantityDto

2 top-level fieldsSelect an object to expand

packageIdnumberRequired
minimum: 1
productsarray of OptionalProductWithQuantityRequired

POST/api/v1/product-packages/subscribe

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

GET/api/v1/product-packages/duplicated-packages-with-slug/{tenantId}/{slug}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

tenantIdnumberRequired
slugstringRequired

Query parameters1

emailstring (email)Required

Responses

6 status codes

Responses 200

GET/api/v1/product-packages/packages-with-subscription-plans/{tenantId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

tenantIdnumberRequired

Query parameters2

emailstring (email)Optional
phonestringOptional
maxLength: 20

Responses

6 status codes

Responses 200

GET/api/v1/product-packages/repeat-purchase-eligibility/{tenantId}/{packageId}

Returns { verdict: allow | warn | block }. Shares the same evaluator as the payment-intent enforcement (SUBRITE-467) so checkout and the backend never drift.

Authentication: Bearer token (JWT)

Parameters

Path parameters2

tenantIdnumberRequired
packageIdnumberRequired

Query parameters2

emailstring (email)Optional
phonestringOptional

Schema ExamplePackageResponsePaginated

200 · application/json

{
  "items": [
    {
      "paymentProviders": [],
      "products": [],
      "description": {},
      "packageProducts": [],
      "payments": [],
      "memberPackages": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 21 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 presentField path: errors[].errorType

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

9 status codes

Responses 201

Status201 400 401 403 404 413 415 500 502application/json

Schema ExamplePackageResponse

40 top-level fieldsSelect an object to expand

paymentProvidersarray of PAYMENT_PROVIDERRequired
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
repeatPurchaseControlRepeatPurchaseControlRequired
Allowed values: "allow", "warning", "block_active", "block_forever", "cooldown"
repeatPurchaseCooldownDaysnumber
Can be null
displayOrdernumber
Can be null
seoSeoRequired2 fields
seo
- noIndexbooleanRequiredField path: seo.noIndex
  Ask search engines not to index the resource's own page — for a package, its checkout page (robots "noindex"). The page stays reachable by direct link.
- noFollowbooleanRequiredField path: seo.noFollow
  Ask search engines not to follow links on the resource's own page — for a package, its checkout page (robots "nofollow").
onboardingWelcomeRedirectCTATextTranslationRequiredCan be null5 fields
onboardingWelcomeRedirectCTAText
- enstringRequired when parent is presentField path: onboardingWelcomeRedirectCTAText.en
- nostringRequired when parent is presentField path: onboardingWelcomeRedirectCTAText.no
- svstringField path: onboardingWelcomeRedirectCTAText.sv
- dastringField path: onboardingWelcomeRedirectCTAText.da
customPeriodTextTranslationRequiredCan be null5 fields
customPeriodText
- enstringRequired when parent is presentField path: customPeriodText.en
- nostringRequired when parent is presentField path: customPeriodText.no
- svstringField path: customPeriodText.sv
- dastringField path: customPeriodText.da
- keystringField path: customPeriodText.key
subscriptionCountnumberRequired
productsarray of PackProductRequiredCan be null14 fields
products
- 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 presentField path: products[].currency
- taxnumberRequired when parent is presentField path: products[].tax
pricenumberRequired
Default: 0
recurringPricenumberRequired
isAvailableOnMyPagebooleanRequired
isAvailableForManualOrderViaAdminbooleanRequired
customInputFieldsCustomInputFieldsRequired3 fields
customInputFields
- memberTypebooleanRequiredField path: customInputFields.memberType
- invoiceAddressbooleanRequiredField path: customInputFields.invoiceAddress
- citybooleanRequiredField path: customInputFields.city
salesTitlestringRequired
uuidstringRequired
subscriptionPlanIdnumberRequired
slugstringRequired
imagestringRequired
namestringRequired
descriptionobjectRequired
billingPeriodstringRequired
Allowed values: "monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"
billingPeriodUnitstringRequired
Allowed values: "day", "week", "month", "year"
billingPeriodFrequencynumberRequired
statusstringRequired
Allowed values: "draft", "published", "archived"
isAvailableViaSlugbooleanRequired
allowSameSubscriptionChangebooleanRequired
allowDifferentSubscriptionSwitchbooleanRequired
tenantIdnumberRequired
orderCtaLabelTranslationRequired5 fields
orderCtaLabel
- enstringRequiredField path: orderCtaLabel.en
- nostringRequiredField path: orderCtaLabel.no
- svstringField path: orderCtaLabel.sv
- dastringField path: orderCtaLabel.da
- keystringField path: orderCtaLabel.key
introPeriodFixedEndDatestring (date-time)Required
packageProductsarray of PackageProductRequiredNested fields omitted: field limit.
subscriptionPlanSubscriptionPlanRequiredNested fields omitted: field limit.
paymentsarray of PaymentRequiredNested 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

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

Schema ExamplePackageResponse

201 · application/json

Responses 400

Status201 400 401 403 404 413 415 500 502application/json

Body validation failed, a product id is unknown, the plan products are not all included, or the intro-period/billing-period combination is invalid; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

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

Responses 401

unauthorized

This response has no body.

Responses 403

Status201 400 401 403 404 413 415 500 502application/json

forbiddenResource

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 413 415 500 502application/json

subscriptionPlanNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "subscriptionPlanNotFound"
messagestring

Responses 413

fileSizeExceeded

This response has no body.

Responses 415

invalidFileType

This response has no body.

Responses 500

Status201 400 401 403 404 413 415 500 502application/json

internalServerError

SchemaErrorResponse

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

Responses 502

Status201 400 401 403 404 413 415 500 502application/json

The image could not be stored; the package was not created

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "packageImageUploadFailed"
message

Example requestcurl

curl

curl https://api.subrite.no/api/v1/product-packages \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --form 'salesTitle=string' \
  --form 'name=string' \
  --form 'image=@<file>' \
  --form 'status=draft'

Schema Examplearray of MinimalPackageResponse

200 · application/json

[
  {
    "packName": "string",
    "name": "string",
    "id": 0,
    "slug": "string"
  }
]

Example · 8 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

packName

string

Schema Examplearray of MinimalPackageResponse

200 · application/json

[
  {
    "packName": "string",
    "name": "string",
    "id": 0,
    "slug": "string"
  }
]

Example · 8 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema Examplearray of PackageResponse

40 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"
repeatPurchaseControlRepeatPurchaseControlRequired when parent is present
Allowed values: "allow", "warning", "block_active", "block_forever", "cooldown"
repeatPurchaseCooldownDaysnumber
Can be null
displayOrdernumber
Can be null
seoSeoRequired when parent is present2 fields
[].seo
- noIndexbooleanRequired when parent is presentField path: [].seo.noIndex
  Ask search engines not to index the resource's own page — for a package, its checkout page (robots "noindex"). The page stays reachable by direct link.
- noFollowbooleanRequired when parent is presentField path: [].seo.noFollow
  Ask search engines not to follow links on the resource's own page — for a package, its checkout page (robots "nofollow").
onboardingWelcomeRedirectCTATextTranslationRequired when parent is presentCan be null5 fields
[].onboardingWelcomeRedirectCTAText
- enstringRequired when parent is presentField path: [].onboardingWelcomeRedirectCTAText.en
- nostringRequired when parent is presentField path: [].onboardingWelcomeRedirectCTAText.no
- svstringField path: [].onboardingWelcomeRedirectCTAText.sv
- dastringField path: [].onboardingWelcomeRedirectCTAText.da
customPeriodTextTranslationRequired when parent is presentCan be null5 fields
[].customPeriodText
- enstringRequired when parent is presentField path: [].customPeriodText.en
- nostringRequired when parent is presentField path: [].customPeriodText.no
- svstringField path: [].customPeriodText.sv
- dastringField path: [].customPeriodText.da
- keystringField path: [].customPeriodText.key
subscriptionCountnumberRequired when parent is present
productsarray of PackProductRequired when parent is presentCan be null14 fields
[].products
- 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 presentField path: [].products[].currency
- taxnumberRequired when parent is presentField path: [].products[].tax
pricenumberRequired when parent is present
Default: 0
recurringPricenumberRequired when parent is present
isAvailableOnMyPagebooleanRequired when parent is present
isAvailableForManualOrderViaAdminbooleanRequired when parent is present
customInputFieldsCustomInputFieldsRequired when parent is present3 fields
[].customInputFields
- memberTypebooleanRequired when parent is presentField path: [].customInputFields.memberType
- invoiceAddressbooleanRequired when parent is presentField path: [].customInputFields.invoiceAddress
- citybooleanRequired when parent is presentField path: [].customInputFields.city
salesTitlestringRequired when parent is present
uuidstringRequired when parent is present
subscriptionPlanIdnumberRequired when parent is present
slugstringRequired when parent is present
imagestringRequired when parent is present
namestringRequired when parent is present
descriptionobjectRequired 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
statusstringRequired when parent is present
Allowed values: "draft", "published", "archived"
isAvailableViaSlugbooleanRequired when parent is present
allowSameSubscriptionChangebooleanRequired when parent is present
allowDifferentSubscriptionSwitchbooleanRequired when parent is present
tenantIdnumberRequired when parent is present
orderCtaLabelTranslationRequired when parent is present5 fields
[].orderCtaLabel
- enstringRequired when parent is presentField path: [].orderCtaLabel.en
- nostringRequired when parent is presentField path: [].orderCtaLabel.no
- svstringField path: [].orderCtaLabel.sv
- dastringField path: [].orderCtaLabel.da
- keystringField path: [].orderCtaLabel.key
introPeriodFixedEndDatestring (date-time)Required when parent is present
packageProductsarray of PackageProductRequired when parent is presentNested fields omitted: field limit.
subscriptionPlanSubscriptionPlanRequired when parent is presentNested fields omitted: field limit.
paymentsarray of PaymentRequired 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

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

Schema Examplearray of PackageResponse

200 · application/json

[
  {
    "paymentProviders": [],
    "repeatPurchaseControl": "allow",
    "repeatPurchaseCooldownDays": 0,
    "displayOrder": 0,
    "seo": {},
    "onboardingWelcomeRedirectCTAText": {},
    "customPeriodText": {},
    "subscriptionCount": 0,
    "products": [],
    "price": 0,
    "recurringPrice": 0,
    "isAvailableOnMyPage": true,
    "isAvailableForManualOrderViaAdmin": true,
    "customInputFields": {},
    "salesTitle": "string",
    "uuid": "string",
    "subscriptionPlanId": 0,
    "slug": "string",
    "image": "string",
    "name": "string",
    "description": {},
    "billingPeriod": "monthly",
    "billingPeriodUnit": "day",
    "billingPeriodFrequency": 0,
    "status": "draft",
    "isAvailableViaSlug": true,
    "allowSameSubscriptionChange": true,
    "allowDifferentSubscriptionSwitch": true,
    "tenantId": 0,
    "orderCtaLabel": {},
    "introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
    "packageProducts": [],
    "subscriptionPlan": {
      "paymentProviders": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packages": [],
      "memberPackages": [],
      "metaData": {}
    },
    "payments": [],
    "memberPackages": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Responses 400

Status200 400 401 403 500application/json

Query validation failed; field codes in errors[]

Schema ExampleErrorResponse

Same fields as Get all packages 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 packages of the tenant (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 lines

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

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

Schema ExamplePackageResponse

200 · application/json

{
  "paymentProviders": [
    "stripe"
  ],
  "repeatPurchaseControl": "allow",
  "repeatPurchaseCooldownDays": 0,
  "displayOrder": 0,
  "seo": {
    "noIndex": true,
    "noFollow": true
  },
  "onboardingWelcomeRedirectCTAText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "customPeriodText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "price": 0,
  "recurringPrice": 0,
  "isAvailableOnMyPage": true,
  "isAvailableForManualOrderViaAdmin": true,
  "customInputFields": {
    "memberType": true,
    "invoiceAddress": true,
    "city": true
  },
  "salesTitle": "string",
  "uuid": "string",
  "subscriptionPlanId": 0,
  "slug": "string",
  "image": "string",
  "name": "string",
  "description": {},
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "status": "draft",
  "isAvailableViaSlug": true,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "tenantId": 0,
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
  "packageProducts": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlan": {
    "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": {}
  },
  "payments": [
    {
      "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": {}
}

Example · 150 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 packages 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

packageNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "packageNotFound"
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": "packageNotFound",
  "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", "packageIsActiveAsSubscriptions", "packageIsReferencedInSettings"
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 packages 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

packageNotFound

Schema ExampleErrorResponse

Same fields as Get a package by id (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

9 status codes

Responses 200

Status200 400 401 403 404 413 415 500 502application/json

Schema ExamplePackageResponse

Same fields as Create a new package (201).

Schema ExamplePackageResponse

200 · application/json

{
  "paymentProviders": [
    "stripe"
  ],
  "repeatPurchaseControl": "allow",
  "repeatPurchaseCooldownDays": 0,
  "displayOrder": 0,
  "seo": {
    "noIndex": true,
    "noFollow": true
  },
  "onboardingWelcomeRedirectCTAText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "customPeriodText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "price": 0,
  "recurringPrice": 0,
  "isAvailableOnMyPage": true,
  "isAvailableForManualOrderViaAdmin": true,
  "customInputFields": {
    "memberType": true,
    "invoiceAddress": true,
    "city": true
  },
  "salesTitle": "string",
  "uuid": "string",
  "subscriptionPlanId": 0,
  "slug": "string",
  "image": "string",
  "name": "string",
  "description": {},
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "status": "draft",
  "isAvailableViaSlug": true,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "tenantId": 0,
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
  "packageProducts": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlan": {
    "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": {}
  },
  "payments": [
    {
      "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": {}
}

Example · 150 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 413 415 500 502application/json

Body validation failed, the id is not an integer, a product id is unknown, or the intro-period/billing-period combination is invalid; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

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

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 404 413 415 500 502application/json

forbiddenResource

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status200 400 401 403 404 413 415 500 502application/json

packageNotFound

Schema ExampleErrorResponse

Same fields as Get a package by id (404).

Schema ExampleErrorResponse

404 · application/json

Responses 413

fileSizeExceeded

This response has no body.

Responses 415

invalidFileType

This response has no body.

Responses 500

Status200 400 401 403 404 413 415 500 502application/json

internalServerError

SchemaErrorResponse

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

Responses 502

Status200 400 401 403 404 413 415 500 502application/json

The new image could not be stored; nothing was saved

Schema ExampleErrorResponse

Same fields as Create a new package (502).

Schema ExampleErrorResponse

Schema ExamplePackageResponse

200 · application/json

{
  "paymentProviders": [
    "stripe"
  ],
  "repeatPurchaseControl": "allow",
  "repeatPurchaseCooldownDays": 0,
  "displayOrder": 0,
  "seo": {
    "noIndex": true,
    "noFollow": true
  },
  "onboardingWelcomeRedirectCTAText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "customPeriodText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "price": 0,
  "recurringPrice": 0,
  "isAvailableOnMyPage": true,
  "isAvailableForManualOrderViaAdmin": true,
  "customInputFields": {
    "memberType": true,
    "invoiceAddress": true,
    "city": true
  },
  "salesTitle": "string",
  "uuid": "string",
  "subscriptionPlanId": 0,
  "slug": "string",
  "image": "string",
  "name": "string",
  "description": {},
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "status": "draft",
  "isAvailableViaSlug": true,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "tenantId": 0,
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
  "packageProducts": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlan": {
    "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": {}
  },
  "payments": [
    {
      "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": {}
}

Example · 150 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The tenantId is not an integer, the slug is malformed, or the campaign has ended

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "campaignIsOver"
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
- message

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 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

No published package has that slug in the tenant, or it is not offered via its slug

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "packageNotFound", "notAvailableViaSlug"
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
- message

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

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

A path segment is not an integer

Schema ExampleErrorResponse

Same fields as Get a package by id (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

packageNotFound

Schema ExampleErrorResponse

Same fields as Get a package by id (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

minimum

0

Responses

5 status codes

Responses 200

This response has no body.

Responses 400

Status200 400 401 403 500application/json

Body validation failed, or a package 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", "invalidPackages"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

403 · application/json

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

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

Example requestcurl

curl

curl https://api.subrite.no/api/v1/product-packages/display-order/all \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "id": 0,
    "displayOrder": 0
  }
]'

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExamplePackageResponse

Same fields as Create a new package (201).

Schema ExamplePackageResponse

201 · application/json

{
  "paymentProviders": [
    "stripe"
  ],
  "repeatPurchaseControl": "allow",
  "repeatPurchaseCooldownDays": 0,
  "displayOrder": 0,
  "seo": {
    "noIndex": true,
    "noFollow": true
  },
  "onboardingWelcomeRedirectCTAText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "customPeriodText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "price": 0,
  "recurringPrice": 0,
  "isAvailableOnMyPage": true,
  "isAvailableForManualOrderViaAdmin": true,
  "customInputFields": {
    "memberType": true,
    "invoiceAddress": true,
    "city": true
  },
  "salesTitle": "string",
  "uuid": "string",
  "subscriptionPlanId": 0,
  "slug": "string",
  "image": "string",
  "name": "string",
  "description": {},
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "status": "draft",
  "isAvailableViaSlug": true,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "tenantId": 0,
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
  "packageProducts": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlan": {
    "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": {}
  },
  "payments": [
    {
      "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": {}
}

Example · 150 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

Body validation failed; field codes in errors[]

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

400 · application/json

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

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

Responses 404

Status201 400 401 403 404 500application/json

packageNotFound

Schema ExampleErrorResponse

Same fields as Get a package by id (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

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

Example requestcurl

curl

curl https://api.subrite.no/api/v1/product-packages/price-by-quantity \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "packageId": 1,
  "products": [
    {}
  ]
}'

Schema ExamplePrePurchasePackageSubscriptionDto

application/json

{
  "packageId": 1,
  "paymentDate": "2019-08-24T14:15:22Z",
  "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
  "reference": "string"
}

Example · 6 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExamplePrePurchasePackageResponseDto

41 top-level fieldsSelect an object to expand

memberIdstringRequired
packageIdnumberRequired
subscriptionPlanIdnumberRequired
recurringPricenumberRequired
hasCustomPricebooleanRequired
currentPricenumberRequired
statusstringRequired
Allowed values: "active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"
autoRenewbooleanRequired
nextRenewalstring (date-time)Required
renewalAnchorDatestring (date-time)Required
currentPeriodStartstring (date-time)Required
forcedStopDatestring (date-time)Required
cancelledAtstring (date-time)Required
isCustomizedbooleanRequired
paymentProviderstringRequired
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
referencestringRequired
lastActiveAtstring (date-time)Required
isOnIntroPeriodbooleanRequired
nextOrderDatestring (date-time)Required
scheduledActivationDatestring (date-time)Required
Can be null
packagePackageRequired35 fields
package
- paymentProvidersarray of PAYMENT_PROVIDERRequiredField path: package.paymentProviders
  Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
- repeatPurchaseControlRepeatPurchaseControlRequiredField path: package.repeatPurchaseControl
  Allowed values: "allow", "warning", "block_active", "block_forever", "cooldown"
- repeatPurchaseCooldownDaysnumberField path: package.repeatPurchaseCooldownDays
  Can be null
subscriptionPlanSubscriptionPlanRequiredNested fields omitted: field limit.
memberMemberRequiredNested fields omitted: field limit.
memberPackageProductsarray of MemberPackageProductRequiredNested fields omitted: field limit.
ordersarray of OrderRequiredNested fields omitted: field limit.
memberPackageProviderPaymentMemberPackageProviderPaymentRequiredNested fields omitted: field limit.
changesarray of MemberPackageChangeRequiredNested fields omitted: field limit.
historiesarray of MemberPackageHistoryRequiredNested fields omitted: field limit.
tenantIdnumberRequired
tenantTenantRequiredNested fields omitted: field limit.
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired
planNamestringRequired
packageNamestringRequired
emailstringRequired
fullNamestringRequired
paymentDatestringRequired
paymentMethodstringRequired

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

Responses 400

Status201 400 401 403 404 500application/json

Body validation failed; field codes in errors[]

Responses 401

unauthorized

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Responses 404

Status201 400 401 403 404 500application/json

No such package, or no member with that id in this tenant

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/product-packages/subscribe \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "packageId": 1,
  "optionalProducts": [
    {}
  ],
  "paymentDate": "2019-08-24T14:15:22Z",
  "memberId": "92983ab9-49c8-444b-85ae-6e40402cf72e",
  "reference": "string"
}'

application/json

Schema Examplearray of MinimalMemberPackageResponseDto

7 top-level fields

packageNamestringRequired when parent is present
memberEmailstringRequired when parent is present
statusstringRequired when parent is present
nextRenewalstring (date-time)Required when parent is present
expiresAtstring (date-time)Required when parent is present
currentPeriodStartstring (date-time)Required when parent is present
autoRenewbooleanRequired when parent is present

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

Schema Examplearray of MinimalMemberPackageResponseDto

200 · application/json

[
  {
    "packageName": "string",
    "memberEmail": "string",
    "status": "string",
    "nextRenewal": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "currentPeriodStart": "2019-08-24T14:15:22Z",
    "autoRenew": true
  }
]

Example · 11 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The tenantId is not an integer, the slug is malformed, the email is missing or invalid, or the campaign has ended; field codes in errors[]

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "internalServerError", "campaignIsOver"
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

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 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

No published package has that slug in the tenant, or it is not offered via its slug

Schema ExampleErrorResponse

Same fields as Get a package by slug (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

Schema Examplearray of MinimalMemberPackageResponseWithPlanDto

3 top-level fields

packageNamestringRequired when parent is present
statusstringRequired when parent is present
planNamestringRequired when parent is present

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

Schema Examplearray of MinimalMemberPackageResponseWithPlanDto

200 · application/json

[
  {
    "packageName": "string",
    "status": "string",
    "planName": "string"
  }
]

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

The tenantId is not an integer, or neither a valid email nor a phone is given; field codes in errors[]

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

memberNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "memberNotFound"
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

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

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleRepeatPurchaseEligibilityResponseDto

2 top-level fields

verdictstringRequired
Allowed values: "allow", "warn", "block"
reasonstring
Can be null

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

Schema ExampleRepeatPurchaseEligibilityResponseDto

200 · application/json

{
  "verdict": "allow",
  "reason": "string"
}

Example · 4 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

A path segment is not an integer, or the email or phone is invalid; field codes in errors[]

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

Responses 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

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

Schema ExampleErrorResponse

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

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

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

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

key

string

{
  "paymentProviders": [
    "stripe"
  ],
  "repeatPurchaseControl": "allow",
  "repeatPurchaseCooldownDays": 0,
  "displayOrder": 0,
  "seo": {
    "noIndex": true,
    "noFollow": true
  },
  "onboardingWelcomeRedirectCTAText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "customPeriodText": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "subscriptionCount": 0,
  "products": [
    {
      "shippingCharges": []
    }
  ],
  "price": 0,
  "recurringPrice": 0,
  "isAvailableOnMyPage": true,
  "isAvailableForManualOrderViaAdmin": true,
  "customInputFields": {
    "memberType": true,
    "invoiceAddress": true,
    "city": true
  },
  "salesTitle": "string",
  "uuid": "string",
  "subscriptionPlanId": 0,
  "slug": "string",
  "image": "string",
  "name": "string",
  "description": {},
  "billingPeriod": "monthly",
  "billingPeriodUnit": "day",
  "billingPeriodFrequency": 0,
  "status": "draft",
  "isAvailableViaSlug": true,
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "tenantId": 0,
  "orderCtaLabel": {
    "en": "string",
    "no": "string",
    "sv": "string",
    "da": "string",
    "key": "string"
  },
  "introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
  "packageProducts": [
    {
      "metaData": {}
    }
  ],
  "subscriptionPlan": {
    "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": {}
  },
  "payments": [
    {
      "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": {}
}

, "setEitherIntroPeriodFixedEndDateOrBillingPeriod"

, "introPeriodFixedEndDateAndBillingPeriodCannotCoexist"

, "missingUnitOrFrequencyForCustomBillingPeriod"

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

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

string

Schema ExampleErrorResponse

502 · application/json

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

Example · 7 linesShow full heightShow compact view

"setEitherIntroPeriodFixedEndDateOrBillingPeriod"

, "introPeriodFixedEndDateAndBillingPeriodCannotCoexist"

, "missingUnitOrFrequencyForCustomBillingPeriod"

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

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

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

string

identifier

string

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

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

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

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

{
  "memberId": "string",
  "packageId": 0,
  "subscriptionPlanId": 0,
  "recurringPrice": 0,
  "hasCustomPrice": true,
  "currentPrice": 0,
  "status": "active",
  "autoRenew": true,
  "nextRenewal": "2019-08-24T14:15:22Z",
  "renewalAnchorDate": "2019-08-24T14:15:22Z",
  "currentPeriodStart": "2019-08-24T14:15:22Z",
  "forcedStopDate": "2019-08-24T14:15:22Z",
  "cancelledAt": "2019-08-24T14:15:22Z",
  "isCustomized": true,
  "paymentProvider": "stripe",
  "reference": "string",
  "lastActiveAt": "2019-08-24T14:15:22Z",
  "isOnIntroPeriod": true,
  "nextOrderDate": "2019-08-24T14:15:22Z",
  "scheduledActivationDate": "2019-08-24T14:15:22Z",
  "package": {
    "paymentProviders": [],
    "repeatPurchaseControl": "allow",
    "repeatPurchaseCooldownDays": 0,
    "displayOrder": 0,
    "seo": {},
    "salesTitle": "string",
    "uuid": "string",
    "subscriptionPlanId": 0,
    "slug": "string",
    "image": "string",
    "name": "string",
    "description": {},
    "billingPeriod": "monthly",
    "billingPeriodUnit": "day",
    "billingPeriodFrequency": 0,
    "status": "draft",
    "isAvailableOnMyPage": true,
    "isAvailableViaSlug": true,
    "isAvailableForManualOrderViaAdmin": true,
    "allowSameSubscriptionChange": true,
    "allowDifferentSubscriptionSwitch": true,
    "tenantId": 0,
    "onboardingWelcomeRedirectCTAText": {},
    "customPeriodText": {},
    "orderCtaLabel": {},
    "introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
    "packageProducts": [],
    "subscriptionPlan": {
      "paymentProviders": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packages": [],
      "memberPackages": [],
      "metaData": {}
    },
    "payments": [],
    "memberPackages": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "subscriptionPlan": {
    "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": {}
  },
  "member": {
    "userId": 0,
    "memberNumber": 0,
    "tenantId": 0,
    "externalId": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "avatar": "string",
    "email": "string",
    "birthDate": "<birthDate>",
    "phone": "<phone>",
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "deleteAfterExpiration": true,
    "customPropertyValues": {},
    "productRecipients": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "memberPackageProducts": [
    {
      "memberPackageProductEmailDomains": [],
      "memberPackageProductIps": [],
      "seats": [],
      "recipients": [],
      "metaData": {}
    }
  ],
  "orders": [
    {
      "orderItems": [],
      "metaData": {}
    }
  ],
  "memberPackageProviderPayment": {
    "memberPackageId": 0,
    "paymentInfo": {},
    "isSaved": true,
    "cardInfo": {},
    "memberPackage": {
      "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": {}
  },
  "changes": [
    {
      "metaData": {}
    }
  ],
  "histories": [
    {
      "newData": {},
      "metaData": {}
    }
  ],
  "tenantId": 0,
  "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": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {},
  "planName": "string",
  "packageName": "string",
  "email": "string",
  "fullName": "<fullName>",
  "paymentDate": "string",
  "paymentMethod": "string"
}

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

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

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

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

Get all packages of the tenant#

Parameters

Responses

Responses 200

Create a new package#

Request body

Get free packages#

Responses

Responses 200

Get packages available for manual order by admin#

Responses

Responses 200

Get packages by filters#

Parameters

Get a package by id#

Parameters

Responses

Responses 200

Delete a package#

Parameters

Responses

Responses 200

Responses 400

Update a package#

Parameters

Request body

Get a package by slug#

Parameters

Responses

Responses 200

Get a package slug by id#

Parameters

Responses

Responses 200

Update the mypage display order of packages for a tenant#

Request body

Get introductory & recurring price by quantity of optional products#

Request body

Create a subscription for pre-puchased package#

Request body

get duplicated packages with slug#

Parameters

Responses

Responses 200

get packages with subscription plans#

Parameters

Responses

Responses 200

Check whether a member may buy the same package again, per the package repeat-purchase control#

Parameters

Get all packages of the tenant#

Parameters

Responses

Responses 200

Create a new package#

Request body

Get free packages#

Responses

Responses 200

Get packages available for manual order by admin#

Responses

Responses 200

Get packages by filters#

Parameters

Get a package by id#

Parameters

Responses

Responses 200

Delete a package#

Parameters

Responses

Responses 200

Responses 400

Update a package#

Parameters

Request body

Get a package by slug#

Parameters

Responses

Responses 200