Member Profile | Subrite

Member Profile

Endpoints for Member Profile

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/members/profile/mypage-cards-settings

Authentication: Bearer token (JWT)

Parameters

Query parameters1

showOnMyPagebooleanOptional

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema Examplearray of MypageCardsSettingsResponseDto

7 top-level fieldsSelect an object to expand

titleTranslationRequired when parent is presentCan be null5 fields
[].title
- enstringRequired when parent is presentField path: [].title.en
- nostringRequired when parent is presentField path: [].title.no
- svstringField path: [].title.sv

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring

Responses 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldError

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/mypage-cards-settings \
  --header 'Authorization: Bearer <token>'

Try it

GET/api/v1/members/profile/available-subscriptions-to-join

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema Examplearray of MemberPackageProduct

20 top-level fieldsSelect an object to expand

Join selected available subscriptions (create product seats)#

POST/api/v1/members/profile/join-subscriptions

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleJoinSubscriptionsRequestDto

1 top-level field

memberPackageProductIdsarray of numberRequired
Array of MemberPackageProduct IDs to joinminItems: 1

1 documented field · Scroll to see moreShow full height

GET/api/v1/members/profile

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleMemberPersonalInfo

20 top-level fieldsSelect an object to expand

idstringRequired

PATCH/api/v1/members/profile

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberPersonalInfo

11 top-level fieldsSelect an object to expand

fullNamestringOptional
emailstring (email)Optional
maxLength: 255
birthDatestring (date-time)Optional

GET/api/v1/members/profile/subscriptions

Authentication: Bearer token (JWT)

Parameters

Query parameters2

statusmember_package_status_enumOptional
Allowed values: "active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"
statusGroupsubscription_access_groupOptional
Coarse Active/Inactive filter used by the member subscription list. Takes precedence over status.Allowed values: "active", "inactive"

Responses

5 status codes

Responses 200

GET/api/v1/members/profile/invoices

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema Examplearray of InvoiceResponse

23 top-level fields

idnumber

GET/api/v1/members/profile/orders

Authentication: Bearer token (JWT)

Parameters

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default: "createdAt"Allowed values: "createdAt", "id", "updatedAt"
orderDirectionstringOptional
Default:

Get logged in member info with content access#

GET/api/v1/members/profile/info-with-content-access

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleMemberWithSubscriptions

15 top-level fieldsSelect an object to expand

GET/api/v1/members/profile/info-with-active-subscriptions

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleMemberWithSubscriptions

Same fields as Get logged in member info with content access (200).

Set logged in member avatar or profile picture#

POST/api/v1/members/profile/avatar

Authentication: Bearer token (JWT)

Request body

Required bodymultipart/form-data

SchemaUpdateAvatarDto

3 top-level fields

imagefileOptional
imagePreviewstringOptional
previousImageUrlstringOptional

3 documented fields · Scroll to see more

Request email pre-verification#

POST/api/v1/members/profile/email/pre-verify

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberEmailBodyDto

1 top-level field

emailstring (email)Required

1 documented field · Scroll to see moreShow full heightShow compact view

Schema ExampleUpdateMemberEmailBodyDto

PATCH/api/v1/members/profile/email

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberEmailDto

3 top-level fields

emailstring (email)Required
otpstringRequired
hashstringRequired

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

Request phone pre-verification#

POST/api/v1/members/profile/phone/pre-verify

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberPhoneBodyDto

2 top-level fields

phonestringRequired
languagestringRequired
Allowed values: "en", "no", "sv", "da"

2 documented fields · Scroll to see more

PATCH/api/v1/members/profile/phone

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberPhoneDto

3 top-level fields

phonestringRequired
otpstringRequired
hashstringRequired

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

Request deletion of a member by its own#

POST/api/v1/members/profile/request-account-deletion

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 201

Status201 401 403 404 500application/json

Schema ExampleMemberPersonalInfo

Same fields as Get logged in member personal info (200).

GET/api/v1/members/profile/subscriptions/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleSubscriptionDetails

GET/api/v1/members/profile/subscription-plans/all

Authentication: Bearer token (JWT)

Parameters

Query parameters6

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

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

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

GET/api/v1/members/profile/subscriptions/product/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

GET/api/v1/members/profile/subscriptions/product/{id}/seats

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Query parameters6

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional

PUT/api/v1/members/profile/subscriptions/product/{id}/ip-ranges

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

SchemaReplaceIpRangesDto

1 top-level fieldSelect an object to expand

DELETE/api/v1/members/profile/subscriptions/product/{id}/ip-ranges/{ipRange}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

idnumberRequired
ipRangestringRequired

Responses

6 status codes

Responses 200

Create additional member for a product seat#

POST/api/v1/members/profile/subscriptions/product/{id}/create-member

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleCreateAdditionalMemberDto

11 top-level fieldsSelect an object to expand

Create gift receiver for a product seat#

POST/api/v1/members/profile/subscriptions/product/{id}/create-gift-receiver

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Query parameters1

sendInvitationbooleanOptional

Request body

Required bodyapplication/json

Schema ExampleCreateGiftReceiverDto

4 top-level fields

GET/api/v1/members/profile/invoice/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

This response has no body.

Responses 401

GET/api/v1/members/profile/refund/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

This response has no body.

Responses 401

PATCH/api/v1/members/profile/subscriptions/{id}/auto-renewal/{activate}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

idnumberRequired
activatebooleanRequired

Responses

7 status codes

Responses 200

PATCH/api/v1/members/profile/subscriptions/{id}/activation-date

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberPackageDto

3 top-level fields

autoRenew

GET/api/v1/members/profile/seats/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleSeatData

7 top-level fieldsSelect an object to expand

DELETE/api/v1/members/profile/seats/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

This response has no body.

Responses 401

PATCH/api/v1/members/profile/seats/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberDto

11 top-level fieldsSelect an object to expand

fullNamestringOptional

GET/api/v1/members/profile/seats/{id}/recipient/attached-products

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Invite member to a product seat#

POST/api/v1/members/profile/seats/invite

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleInviteSeatDto

2 top-level fields

emailstring (email)Required
idnumberRequired
minimum: 1

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

Resend invitation to a product seat#

POST/api/v1/members/profile/seats/{seatId}/resend

Authentication: Bearer token (JWT)

Parameters

Path parameters1

seatIdnumberRequired

Request body

Required bodyapplication/json

Schema ExampleResendSeatInvitationDto

1 top-level field

emailstring (email)Optional

1 documented field · Scroll to see more

Accept invitation to a product seat#

POST/api/v1/members/profile/seats/{uuid}/accept

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Accept gift invitation to a product seat#

POST/api/v1/members/profile/seats/{uuid}/accept-gift

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Add invoice address of a subscribed product#

POST/api/v1/members/profile/subscriptions/{id}/invoice-address

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleMemberAddressDto

11 top-level fields

line1stringOptional

PATCH/api/v1/members/profile/subscriptions/{id}/invoice-address

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleMemberAddressDto

Same fields as Add invoice address of a subscribed product (Request body).

Schema ExampleMemberAddressDto

Add delivery address of a subscribed product#

POST/api/v1/members/profile/subscriptions/product/{id}/delivery-address

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleMemberAddressDto

Same fields as Add invoice address of a subscribed product (Request body).

PATCH/api/v1/members/profile/subscriptions/product/{id}/owner-access/{activate}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

idnumberRequired
activatebooleanRequired

Responses

6 status codes

Responses 200

GET/api/v1/members/profile/subscriptions/product/{productId}/delivery-address/{addressId}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

productIdnumberRequired
addressIdnumberRequired

Responses

5 status codes

Responses 200

PATCH/api/v1/members/profile/subscriptions/product/{productId}/delivery-address/{addressId}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

productIdnumberRequired
addressIdnumberRequired

Request body

Required bodyapplication/json

Schema ExampleMemberAddressDto

Same fields as Add invoice address of a subscribed product (Request body).

DELETE/api/v1/members/profile/subscriptions/product/{id}/delivery-address/{addressId}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

idnumberRequired
addressIdnumberRequired

Responses

5 status codes

Responses 200

GET/api/v1/members/profile/consents

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema Examplearray of MemberConsentDto

14 top-level fields

idnumberRequired when parent is present

PATCH/api/v1/members/profile/consents/toggle/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleConsentUpdateDto

3 top-level fields

channelstringRequired
Field details

POST/api/v1/members/profile/consents/default-subscribe

Authentication: Bearer token (JWT)

Responses

6 status codes

Responses 201

Status201 401 403 404 500 502application/json

Change subscription package and products#

POST/api/v1/members/profile/subscriptions/{id}/change

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleChangeSubscriptionDto

4 top-level fieldsSelect an object to expand

planIdnumberOptional

GET/api/v1/members/profile/subscriptions/{id}/change/{changeId}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

idnumberRequired
changeIdnumberRequired

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

PATCH/api/v1/members/profile/subscriptions/{id}/change/{changeId}/cancel

Authentication: Bearer token (JWT)

Parameters

Path parameters2

idnumberRequired
changeIdnumberRequired

Responses

5 status codes

Responses 200

PATCH/api/v1/members/profile/subscriptions/{id}/change/{changeId}/confirm

Authentication: Bearer token (JWT)

Parameters

Path parameters2

idnumberRequired
changeIdnumberRequired

Responses

6 status codes

Responses 200

GET/api/v1/members/profile/missing-info

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema Examplearray of MissingInfoResponse

9 top-level fieldsSelect an object to expand

GET/api/v1/members/profile/login-accounts

Authentication: Bearer token (JWT)

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Get recurring price by quantity of optional products of logged in member subscription#

POST/api/v1/members/profile/subscription-plan/price-by-quantity

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaSubscriptionPlanPriceByQuantityDto

3 top-level fieldsSelect an object to expand

planIdnumberRequired
minimum: 1

DELETE/api/v1/members/profile/login-accounts/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idstringRequired

Responses

5 status codes

Responses 200

Get help text for subscription action#

POST/api/v1/members/profile/subscription-action-help-text/{id}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Request body

Required bodyapplication/json

Schema ExampleSubscriptionActionHelpTextRequestDto

3 top-level fields

languageLANGUAGEOptional

DELETE/api/v1/members/profile/subscriptions/{id}/payment-method

Deletes the card at the payment provider and clears every local copy of it. Allowed only for the paying owner, and only while the subscription cannot be charged — a terminal status, or active with auto-renew off. Idempotent: repeating it on a subscription that stores nothing succeeds.

Authentication: Bearer token (JWT)

Parameters

Path parameters1

idnumberRequired

Responses

6 status codes

Responses 204

Schema Examplearray of MypageCardsSettingsResponseDto

200 · application/json

[
  {
    "title": {},
    "description": {},
    "id": 0,
    "link": "string",
    "cardType": "subrite_standard",
    "showOnMyPage": true,
    "display_order": 0
  }
]

Example · 11 linesShow full heightShow compact view

memberPackageIdnumberRequired when parent is present
productIdnumberRequired when parent is present
pricenumberRequired when parent is present
recurringPricenumberRequired when parent is present
quantitynumberRequired when parent is present
hasAccessbooleanRequired when parent is present
shippingCountrystringRequired when parent is present
shippingProviderstringRequired when parent is present
Allowed values: "Helthjem", "Bring - Posten", "Distribution Innovation"
allowDistributorToUpdateDeliveryAddressbooleanRequired when parent is present
memberPackageProductEmailDomainsarray of MemberPackageProductEmailDomainRequired when parent is present9 fields
[].memberPackageProductEmailDomains
- memberPackageProductIdnumberRequired when parent is presentField path: [].memberPackageProductEmailDomains[].memberPackageProductId
- emailDomainstringRequired when parent is presentField path: [].memberPackageProductEmailDomains[].emailDomain
- updatedBynumberRequired when parent is presentField path: [].memberPackageProductEmailDomains[].updatedBy
- memberPackageProduct
memberPackageProductIpsarray of MemberPackageProductIpRequired when parent is present10 fields
[].memberPackageProductIps
- memberPackageProductIdnumberRequired when parent is presentField path: [].memberPackageProductIps[].memberPackageProductId
- ipRangestringRequired when parent is presentField path: [].memberPackageProductIps[].ipRange
- labelstringRequired when parent is presentField path: [].memberPackageProductIps[].label
- updatedBynumberRequired when parent is presentField path: [].memberPackageProductIps[].updatedBy
memberPackageMemberPackageRequired when parent is present35 fields
[].memberPackage
- memberIdstringRequired when parent is presentField path: [].memberPackage.memberId
- packageIdnumberRequired when parent is presentField path: [].memberPackage.packageId
- subscriptionPlanIdnumberRequired when parent is presentField path: [].memberPackage.subscriptionPlanId
- recurringPricenumberRequired when parent is presentField path: [].memberPackage.recurringPrice
- hasCustomPriceboolean
productProductRequired when parent is presentNested fields omitted: field limit.
seatsarray of MemberPackageProductSeatRequired when parent is presentNested fields omitted: field limit.
recipientsarray of MemberPackageProductRecipientRequired 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

Schema Examplearray of MemberPackageProduct

200 · application/json

[
  {
    "memberPackageId": 0,
    "productId": 0,
    "price": 0,
    "recurringPrice": 0,
    "quantity": 0,
    "hasAccess": true,
    "shippingCountry": "string",
    "shippingProvider": "Helthjem",
    "allowDistributorToUpdateDeliveryAddress": true,
    "memberPackageProductEmailDomains": [],
    "memberPackageProductIps": [],
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "product": {
      "properties": {},
      "shippingCharges": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packageProducts": [],
      "memberPackageProducts": [],
      "orderItem": [],
      "productContents": [],
      "metaData": {}
    },
    "seats": [],
    "recipients": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Example · 40 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

memberEmailMissing, invalidEmailDomain

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "memberEmailMissing", "invalidEmailDomain"
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": "memberEmailMissing",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema Examplearray of MemberPackageProductSeat

14 top-level fieldsSelect an object to expand

memberPackageProductIdnumberRequired when parent is present
memberIdstringRequired when parent is present
emailstringRequired when parent is present
Can be null
acceptedbooleanRequired when parent is present
acceptedAtstring (date-time)Required when parent is present
expiresAtstring (date-time)Required when parent is present
uuidstringRequired when parent is present
memberPackageProductMemberPackageProductRequired when parent is present20 fields
[].memberPackageProduct
- memberPackageIdnumberRequired when parent is presentField path: [].memberPackageProduct.memberPackageId
- productIdnumberRequired when parent is presentField path: [].memberPackageProduct.productId
- pricenumberRequired when parent is presentField path: [].memberPackageProduct.price
- recurringPricenumberRequired when parent is presentField path: [].memberPackageProduct.recurringPrice
memberMemberRequired when parent is present21 fields
[].member
- userIdnumberRequired when parent is presentField path: [].member.userId
  Can be null
- memberNumbernumberRequired when parent is presentField path: [].member.memberNumber
  Can be null
- tenantIdnumberRequired when parent is presentField path: [].member.tenantId
- externalIdstringRequired when parent is presentField path: [].member.externalId
  Can be null
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

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

Schema Examplearray of MemberPackageProductSeat

201 · application/json

[
  {
    "memberPackageProductId": 0,
    "memberId": "string",
    "email": "string",
    "accepted": true,
    "acceptedAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z",
    "uuid": "string",
    "memberPackageProduct": {
      "memberPackageProductEmailDomains": [],
      "memberPackageProductIps": [],
      "seats": [],
      "recipients": [],
      "metaData": {}
    },
    "member": {
      "customPropertyValues": {},
      "productRecipients": [],
      "metaData": {}
    },
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  }
]

Example · 28 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, seatLimitReached

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "seatLimitReached"
messagestring

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "unauthorized"
messagestring

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

403 · application/json

Responses 404

Status201 400 401 403 404 500application/json

notFound, productNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "notFound", "productNotFound"
messagestring

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/join-subscriptions \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "memberPackageProductIds": [
    12,
    45
  ]
}'

Schema ExampleMemberPersonalInfo

200 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound, memberNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "notFound", "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
- 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": "notFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema ExampleUpdateMemberPersonalInfo

application/json

{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "birthDate": "<birthDate>",
  "nickName": "string",
  "phone": "<phone>",
  "countryCode": "string",
  "isCompany": true,
  "companyName": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationNo": "string",
    "companyName": "string",
    "invoiceReference": "string"
  },
  "customPropertyValues": {},
  "deleteAfterExpiration": true
}

Example · 25 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleMemberPersonalInfo

Same fields as Get logged in member personal info (200).

Schema ExampleMemberPersonalInfo

200 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest, alreadyExists, emailChangeRequiresVerification, phoneChangeRequiresVerification

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "alreadyExists", "emailChangeRequiresVerification", "phoneChangeRequiresVerification"
messagestring

Responses 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 lines

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "birthDate": "<birthDate>",
  "nickName": "string",
  "phone": "<phone>",
  "countryCode": "string",
  "isCompany": true,
  "companyName": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationNo": "string",
    "companyName": "string",
    "invoiceReference": "string"
  },
  "customPropertyValues": {},
  "deleteAfterExpiration": true
}'

application/json

Schema Examplearray of SubscriptionListItem

9 top-level fields

idnumberRequired when parent is present
packageIdnumberRequired when parent is present
namestringRequired when parent is present
slugstringRequired when parent is present
statusstringRequired when parent is present
Allowed values: "active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"
nextRenewalstring (date-time)Required when parent is present
hasChangebooleanRequired when parent is present
changePlanNamestring
Can be null
scheduledActivationDatestring (date-time)
Can be null

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

Schema Examplearray of SubscriptionListItem

200 · application/json

[
  {
    "id": 0,
    "packageId": 0,
    "name": "string",
    "slug": "string",
    "status": "active",
    "nextRenewal": "2019-08-24T14:15:22Z",
    "hasChange": true,
    "changePlanName": "string",
    "scheduledActivationDate": "2019-08-24T14:15:22Z"
  }
]

Example · 13 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "notFound"
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": "notFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Schema Examplearray of InvoiceResponse

200 · application/json

[
  {
    "id": 0,
    "type": "payment",
    "invoiceNo": 0,
    "invoiceDate": "2019-08-24T14:15:22Z",
    "packName": "string",
    "memberPackageId": 0,
    "memberId": "string",
    "memberEmail": "string",
    "memberName": "<memberName>",
    "totalAmount": 0,
    "status": "paid",
    "memberPackageStatus": "active",
    "deliveryStatus": "sent_via_einvoice",
    "isCreditNote": true,
    "referencedInvoiceNumber": 0,
    "kid": "string",
    "note": "string",
    "paymentProvider": "stripe",
    "memberNumber": 0,
    "invoiceDueDate": "2019-08-24T14:15:22Z",
    "orderId": 0,
    "autoGenerated": true,
    "creditNoteNumbers": []
  }
]

Example · 27 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

"desc"

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleOrderResponsePaginated

2 top-level fieldsSelect an object to expand

itemsarray of OrderResponseRequired30 fields
items
- idnumberRequired when parent is presentField path: items[].id
- orderDatestring (date-time)Required when parent is presentField path: items[].orderDate
- orderNumbernumberRequired when parent is presentField path: items[].orderNumber
- paymentStatusPAYMENT_STATUSRequired when parent is presentField path: items[].paymentStatus
  Allowed values: "pending", "succeeded", "failed"
- amountnumberRequired when parent is presentField path: items[].amount
- creditnumberRequired when parent is presentField path: items[].credit
- debitnumberRequired when parent is presentField path: items[].debit
- packageNamestringRequired when parent is presentField path: items[].packageName
- planNamestringRequired when parent is presentField path: items[].planName
- paymentProviderPAYMENT_PROVIDERRequired when parent is presentField path: items[].paymentProvider
  Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
- currencystringRequired when parent is presentField path: items[].currency
- billingPeriodInfoBillingPeriodInfoRequired when parent is presentField path: items[].billingPeriodInfo2 fields
  items[].billingPeriodInfo
  - billingPeriodstringRequired when parent is presentField path: items[].billingPeriodInfo.billingPeriod
  - customBillingPeriodBillingPeriodDetailsRequired when parent is presentField path: items[].billingPeriodInfo.customBillingPeriodNested fields omitted: depth limit.
- allowedPaymentProvidersarray of PAYMENT_PROVIDERRequired when parent is presentField path: items[].allowedPaymentProviders
  Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
- tenantIdnumberRequired when parent is presentField path: items[].tenantId
- upgradeDataMemberPackageChangeDataField path: items[].upgradeData5 fields
  items[].upgradeData
  - planChangePlanChangeRequired when parent is presentField path: items[].upgradeData.planChangeNested fields omitted: depth limit.
  - productChangearray of ProductChangeRequired when parent is presentField path: items[].upgradeData.productChangeNested fields omitted: depth limit.
  - optionalProductsarray of OptionalProductWithQuantityRequired when parent is presentField path: items[].upgradeData.optionalProductsNested fields omitted: depth limit.
  - planProductPricesarray of PlanProductPriceSnapshotField path: items[].upgradeData.planProductPrices
- memberPackageIdnumberRequired when parent is presentField path: items[].memberPackageId
- recurringPriceAtOrdernumberRequired when parent is presentField path: items[].recurringPriceAtOrder
- paymentIdnumberRequired when parent is presentField path: items[].paymentId
- paymentTokenstringRequired when parent is presentField path: items[].paymentToken
- typestringRequired when parent is presentField path: items[].type
  Allowed values: "initial", "recurrent", "upgrade", "credit-note", "standalone"
- orderItemsarray of OrderItemRequired when parent is presentField path: items[].orderItems14 fields
  items[].orderItems
  - orderIdnumberRequired when parent is presentField path: items[].orderItems[].orderId
  - productIdnumberRequired when parent is presentField path: items[].orderItems[].productId
  - namestringRequired when parent is presentField path: items[].orderItems[].name
  - pricenumberRequired when parent is presentField path: items[].orderItems[].price
  - taxnumberRequired when parent is present
- paymentPaymentRequired when parent is presentField path: items[].paymentNested fields omitted: field limit.
- memberPackageMemberPackageRequired when parent is presentField path: items[].memberPackageNested fields omitted: field limit.
- invoiceInvoiceRequired when parent is presentField path: items[].invoiceNested fields omitted: field limit.
- tenantTenantRequired when parent is presentField path: items[].tenantNested fields omitted: field limit.
- memberPackageChangeMemberPackageChangeRequired when parent is presentField path: items[].memberPackageChange12 fields
  items[].memberPackageChange
  - isImmediatebooleanRequired when parent is presentField path: items[].memberPackageChange.isImmediate
  - changeInPricenumberRequired when parent is presentField path: items[].memberPackageChange.changeInPrice
  - statusstringRequired when parent is presentField path: items[].memberPackageChange.status
    Allowed values: "CREATED", "PAYMENT_PENDING", "CONFIRMATION_PENDING_FOR_NEXT_RENEWAL", "PENDING_FOR_NEXT_RENEWAL", "COMPLETED", "CANCELLED"
- createdAtstring (date-time)Required when parent is presentField path: items[].createdAt
- updatedAtstring (date-time)Required when parent is presentField path: items[].updatedAt
- deletedAtstring (date-time)Required when parent is presentField path: items[].deletedAt
- metaDataobjectRequired when parent is presentField path: items[].metaData
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExampleOrderResponsePaginated

200 · application/json

{
  "items": [
    {
      "allowedPaymentProviders": [],
      "orderItems": [],
      "metaData": {}
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 17 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status200 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Responses 500

Status200 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleMemberWithSubscriptions

200 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "memberNumber": 0,
  "userType": "system_admin",
  "userId": 0,
  "nickName": "string",
  "avatar": "string",
  "subscriptions": [
    {
      "subscriptionProducts": []
    }
  ],
  "customPropertyValues": {},
  "contentChannels": [
    {}
  ],
  "podcasts": [
    {}
  ],
  "consents": [
    {
      "status": {}
    }
  ],
  "phone": "<phone>",
  "email": "user@example.com",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 42 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 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
- 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": "memberNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

200 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "memberNumber": 0,
  "userType": "system_admin",
  "userId": 0,
  "nickName": "string",
  "avatar": "string",
  "subscriptions": [
    {
      "subscriptionProducts": []
    }
  ],
  "customPropertyValues": {},
  "contentChannels": [
    {}
  ],
  "podcasts": [
    {}
  ],
  "consents": [
    {
      "status": {}
    }
  ],
  "phone": "<phone>",
  "email": "user@example.com",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 42 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

memberNotFound

Schema ExampleErrorResponse

Same fields as Get logged in member info with content access (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

8 status codes

Responses 201

Status201 400 401 403 404 413 415 500application/json

Schema ExampleMemberPersonalInfo

Same fields as Get logged in member personal info (200).

Schema ExampleMemberPersonalInfo

201 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 413 415 500application/json

badRequest, invalidFileType

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "invalidFileType"
message

Responses 401

Status201 400 401 403 404 413 415 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 400 401 403 404 413 415 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 413 415 500application/json

memberNotFound

Schema ExampleErrorResponse

Same fields as Get logged in member info with content access (404).

Schema ExampleErrorResponse

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 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleOTPSendResponseDto

1 top-level field

hashstringRequired

1 documented field · Scroll to see moreShow full heightShow compact view

Schema ExampleOTPSendResponseDto

201 · application/json

{
  "hash": "string"
}

Example · 3 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

alreadyExists, retryAfter5Mins, emailAlreadyVerified

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "alreadyExists", "retryAfter5Mins", "emailAlreadyVerified"
messagestring

Responses 401

Status201 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/email/pre-verify \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com"
}'

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleMemberPersonalInfo

Same fields as Get logged in member personal info (200).

Schema ExampleMemberPersonalInfo

200 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

alreadyExists, invalidOtp, otpExpired

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "alreadyExists", "invalidOtp", "otpExpired"
messagestring
errors

Responses 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status200 400 401 403 500application/json

updateFailed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "updateFailed"
messagestring
errorsarray of FieldErrorRequired

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/email \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "otp": "<otp>",
  "hash": "string"
}'

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Schema ExampleOTPSendResponseDto

Same fields as Request email pre-verification (201).

Schema ExampleOTPSendResponseDto

201 · application/json

{
  "hash": "string"
}

Example · 3 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

phoneNumberIsInvalid, retryAfter5Mins, phoneAlreadyVerified, dailyLimitReached, hourlyLimitReached

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "phoneNumberIsInvalid", "retryAfter5Mins", "phoneAlreadyVerified", "dailyLimitReached", "hourlyLimitReached"
messagestring

Responses 401

Status201 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status201 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/phone/pre-verify \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "<phone>",
  "language": "en"
}'

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleMemberPersonalInfo

Same fields as Get logged in member personal info (200).

Schema ExampleMemberPersonalInfo

200 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

alreadyExists, invalidOtp, otpExpired

Schema ExampleErrorResponse

Same fields as Update email (400).

Schema ExampleErrorResponse

400 · application/json

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

Responses 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status200 400 401 403 500application/json

updateFailed

Schema ExampleErrorResponse

Same fields as Update email (500).

Schema ExampleErrorResponse

500 · application/json

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

Example · 7 lines

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/phone \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "phone": "<phone>",
  "otp": "<otp>",
  "hash": "string"
}'

MemberPersonalInfo

201 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 401

Status201 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status201 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

47 top-level fieldsSelect an object to expand

idnumberRequired
packageIdnumberRequired
namestringRequired
slugstringRequired
subscriptionPlanIdnumberRequired
subscriptionPlanNamestringRequired
recurringPricenumberRequired
autoRenewbooleanRequired
paymentInfoPaymentInfoRequired7 fields
paymentInfo
- stripeCardInfoStripeCardInfoRequiredField path: paymentInfo.stripeCardInfo5 fields
  paymentInfo.stripeCardInfo
  - brandstringRequiredField path: paymentInfo.stripeCardInfo.brand
  - expMonthnumberRequiredField path: paymentInfo.stripeCardInfo.expMonth
  - expYearnumberRequiredField path: paymentInfo.stripeCardInfo.expYear
paymentProviderstring
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
isOwnerbooleanRequired
canRemovePaymentMethodbooleanRequired
Field details
Whether the paying owner may remove the stored payment method. False while the subscription can still be charged, for seat holders, and when nothing is stored. Which provider holds the credential does not gate it: a subscription that has moved to invoice billing can still be holding a card, and that orphan is removable. True for Vipps too, where the stored credential is an agreement rather than a card — name it accordingly in the UI.
hasStoredPaymentMethodbooleanRequired
Whether a chargeable credential is actually stored. Read from paymentInfo, never from the card details: a Stripe Link method is live while storing no brand or last4, so absent card details do not mean absent credential. The UI needs this to tell "no payment method" from "stored, but nothing to display".
isGroupSubscriptionbooleanRequired
statusMEMBER_PACKAGE_STATUSRequired
Allowed values: "active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"
groupOwnerNamestringRequired
productsarray of ProductPackageRequired15 fields
products
- circulationTypeCIRCULATION_TYPEField path: products[].circulationType
  Can be nullAllowed values: "subscription", "single_copy"
- idnumberRequired when parent is presentField path: products[].id
- namestringRequired when parent is presentField path: products[].name
- productIdnumberRequired when parent is presentField path: products[].productId
- productCategorystringRequired when parent is present
currentPeriodBillingInfoBillingPeriodInfoRequired2 fields
currentPeriodBillingInfo
- billingPeriodstringRequiredField path: currentPeriodBillingInfo.billingPeriod
- customBillingPeriodBillingPeriodDetailsRequiredField path: currentPeriodBillingInfo.customBillingPeriodNested fields omitted: field limit.
nextPeriodBillingInfoBillingPeriodInfoRequired2 fields
nextPeriodBillingInfo
- billingPeriodstringRequiredField path: nextPeriodBillingInfo.billingPeriod
- customBillingPeriodBillingPeriodDetailsRequiredField path: nextPeriodBillingInfo.customBillingPeriodNested fields omitted: field limit.
currentPeriodPricenumberRequired
nextPeriodPricenumberRequired
nextRenewalstring (date-time)Required
expiresAtstring (date-time)Required
changeBlockReasonSUBSCRIPTION_CHANGE_BLOCK_REASON
Can be nullAllowed values: "ON_INTRO_PERIOD", "NOT_ACTIVE", "PAST_DUE", "ON_RENEWAL_DAY", "VIPPS_RECURRING_CHARGE_CREATED", "VIPPS_CHARGE_CREATION_WINDOW", "INVOICE_ALREADY_PAID_FOR_NEXT_PERIOD", "INVOICE_NOT_PAID_FOR_CURRENT_PERIOD"
allowSameSubscriptionChangebooleanRequired
allowDifferentSubscriptionSwitchbooleanRequired
allowAdminSameSubscriptionChangebooleanRequired
allowAdminDifferentSubscriptionSwitchbooleanRequired
enableGiftSubscriptionbooleanRequired
allowFutureStartDatebooleanRequired
allowAutoRenewChangebooleanRequired
changeDataChangeSubscriptionDetails
Can be null
Nested fields omitted: field limit.
primaryAddressProfileAddressRequiredNested fields omitted: field limit.
invoiceAddressProfileAddressRequired
Can be null
Nested fields omitted: field limit.
groupOwnerMemberNamestringRequired
groupOwnerMemberIdstringRequired
groupOwnerMemberNumbernumberRequired
groupOwnerPhoneNumberstringRequired
activeSincestring (date-time)Required
currentPeriodStartstring (date-time)Required
currentPeriodEndstring (date-time)Required
scheduledActivationDatestring (date-time)Required
lastActiveAtstring (date-time)
Can be null
hasOptionalProductsInPlanbooleanRequired
inviteAcceptedProductsarray of MemberPackageProductSeatRequiredNested fields omitted: field limit.
recipientAttachedProductsarray of MemberPackageProductRequiredNested fields omitted: field limit.
isLinkboolean

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

Schema ExampleSubscriptionDetails

200 · application/json

{
  "id": 0,
  "packageId": 0,
  "name": "string",
  "slug": "string",
  "subscriptionPlanId": 0,
  "subscriptionPlanName": "string",
  "recurringPrice": 0,
  "autoRenew": true,
  "paymentInfo": {
    "stripeCardInfo": {},
    "isLink": true,
    "netsCardInfo": {},
    "swedbankpayCardInfo": {},
    "vippsPaymentInfoWithDueCharge": {},
    "eInvoicePaymentInfo": {},
    "externalPaymentInfo": {}
  },
  "paymentProvider": "stripe",
  "isOwner": true,
  "canRemovePaymentMethod": true,
  "hasStoredPaymentMethod": true,
  "isGroupSubscription": true,
  "status": "active",
  "groupOwnerName": "<groupOwnerName>",
  "products": [
    {
      "shippingCharges": [],
      "shippingCountries": []
    }
  ],
  "currentPeriodBillingInfo": {
    "billingPeriod": "string",
    "customBillingPeriod": {}
  },
  "nextPeriodBillingInfo": {
    "billingPeriod": "string",
    "customBillingPeriod": {}
  },
  "currentPeriodPrice": 0,
  "nextPeriodPrice": 0,
  "nextRenewal": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "changeBlockReason": "ON_INTRO_PERIOD",
  "allowSameSubscriptionChange": true,
  "allowDifferentSubscriptionSwitch": true,
  "allowAdminSameSubscriptionChange": true,
  "allowAdminDifferentSubscriptionSwitch": true,
  "enableGiftSubscription": true,
  "allowFutureStartDate": true,
  "allowAutoRenewChange": true,
  "changeData": {
    "id": 0,
    "currentPlanName": "string",
    "newPlanName": "string",
    "currentProducts": [],
    "newProducts": [],
    "currentPaymentProviderInfo": {},
    "currentBillingPeriod": {},
    "newBillingPeriod": {},
    "currentPeriodStart": "2019-08-24T14:15:22Z",
    "nextRenewal": "2019-08-24T14:15:22Z",
    "newPeriodStart": "2019-08-24T14:15:22Z",
    "changeInPrice": 0,
    "currentRecurringPrice": 0,
    "nextRenewalPrice": 0,
    "autoRenew": true,
    "newPackageAutoRenew": true,
    "orderId": 0
  },
  "primaryAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  },
  "invoiceAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  },
  "groupOwnerMemberName": "<groupOwnerMemberName>",
  "groupOwnerMemberId": "string",
  "groupOwnerMemberNumber": 0,
  "groupOwnerPhoneNumber": "<groupOwnerPhoneNumber>",
  "activeSince": "2019-08-24T14:15:22Z",
  "currentPeriodStart": "2019-08-24T14:15:22Z",
  "currentPeriodEnd": "2019-08-24T14:15:22Z",
  "scheduledActivationDate": "2019-08-24T14:15:22Z",
  "lastActiveAt": "2019-08-24T14:15:22Z",
  "hasOptionalProductsInPlan": true,
  "inviteAcceptedProducts": [
    {
      "metaData": {}
    }
  ],
  "recipientAttachedProducts": [
    {
      "memberPackageProductEmailDomains": [],
      "memberPackageProductIps": [],
      "seats": [],
      "recipients": [],
      "metaData": {}
    }
  ],
  "isLink": true
}

Example · 124 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "notFound",
  "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 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

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (400).

Schema ExampleErrorResponse

400 · application/json

Responses 401

Status200 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

SubscriptionPlanResponse

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

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 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

MemberSubscribedProduct

20 top-level fieldsSelect an object to expand

idnumberRequired
productIdnumberRequired
namestringRequired
productCategoryProductCategory
Allowed values: "digital_subscription", "physical_subscription", "physical", "event_ticket", "PHYSICAL_PRODUCT"
circulationTypeCIRCULATION_TYPE
Can be nullAllowed values: "subscription", "single_copy"
quantitynumberRequired
pricenumberRequired
recurringPricenumberRequired
isOptionalbooleanRequired
shippingCountrystringRequired
shippingProviderSHIPPING_PROVIDERRequired
Allowed values: "Helthjem", "Bring - Posten", "Distribution Innovation"
allowDistributorToUpdateDeliveryAddressbooleanRequired
deliveryAddressesarray of DeliveryAddress14 fields
deliveryAddresses
- idnumberRequired when parent is presentField path: deliveryAddresses[].id
- routestringField path: deliveryAddresses[].route
  Can be nullThe DI carrier route for this address.
- line1stringRequired when parent is presentField path: deliveryAddresses[].line1
- line2stringRequired when parent is presentField path: deliveryAddresses[].line2
- citystringRequired when parent is present
groupInfoGroupSubscriptionResponse11 fields
groupInfo
- ownerHasAccessbooleanRequired when parent is presentField path: groupInfo.ownerHasAccess
  Default: false
- seatsAllowednumberRequired when parent is presentField path: groupInfo.seatsAllowed
  Default: 0
- seatsActivenumberRequired when parent is presentField path: groupInfo.seatsActive
  Default: 0
- seatsRemainingnumberRequired when parent is presentField path: groupInfo.seatsRemaining
  Default: 0
giftReceiverInfoGiftReceiverResponse8 fields
giftReceiverInfo
- seatsAllowednumberRequired when parent is presentField path: giftReceiverInfo.seatsAllowed
  Default: 0
- seatsActivenumberRequired when parent is presentField path: giftReceiverInfo.seatsActive
  Default: 0
- seatsRemainingnumberRequired when parent is presentField path: giftReceiverInfo.seatsRemaining
  Default: 0
- maxQuantityPerOrdernumberRequired when parent is presentField path: giftReceiverInfo.maxQuantityPerOrder
primaryAddressProfileAddress12 fields
primaryAddress
- line1stringRequired when parent is presentField path: primaryAddress.line1
- line2stringRequired when parent is presentField path: primaryAddress.line2
- citystringRequired when parent is presentField path: primaryAddress.city
- postCodestringRequired when parent is presentField path: primaryAddress.postCode
- countrystringRequired when parent is presentField path: primaryAddress.country
emailDomainsarray of string
supportsIpAccessbooleanRequired
Whether this product allows configuring IP-based access ranges.
supportsIpRangeConfigurationbooleanRequired
True when the IP-range editor should be shown: subscription is ACTIVE, product category is DIGITAL_SUBSCRIPTION, and the product has IP access enabled.
ipRangesarray of IpRangeDtoRequired2 fields
ipRanges
- ipRangestringRequired when parent is presentField path: ipRanges[].ipRange
- labelstringField path: ipRanges[].label

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

Schema ExampleMemberSubscribedProduct

200 · application/json

{
  "id": 0,
  "productId": 0,
  "name": "string",
  "productCategory": "digital_subscription",
  "circulationType": "subscription",
  "quantity": 0,
  "price": 0,
  "recurringPrice": 0,
  "isOptional": true,
  "shippingCountry": "string",
  "shippingProvider": "Helthjem",
  "allowDistributorToUpdateDeliveryAddress": true,
  "deliveryAddresses": [
    {}
  ],
  "groupInfo": {
    "ownerHasAccess": false,
    "seatsAllowed": 0,
    "seatsActive": 0,
    "seatsRemaining": 0,
    "groupMemberCount": 0,
    "maxQuantityPerOrder": 0,
    "assignSeatToOwner": true,
    "groupOwnerMemberName": "<groupOwnerMemberName>",
    "groupOwnerMemberId": "string",
    "groupOwnerMemberNumber": 0,
    "seats": []
  },
  "giftReceiverInfo": {
    "seatsAllowed": 0,
    "seatsActive": 0,
    "seatsRemaining": 0,
    "maxQuantityPerOrder": 0,
    "groupOwnerMemberName": "<groupOwnerMemberName>",
    "groupOwnerMemberId": "string",
    "groupOwnerMemberNumber": 0,
    "seats": []
  },
  "primaryAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  },
  "emailDomains": [
    "string"
  ],
  "supportsIpAccess": true,
  "supportsIpRangeConfiguration": true,
  "ipRanges": [
    {}
  ]
}

Example · 62 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 401 403 404 500application/json

Schema ExampleSeatDataPaginated

2 top-level fieldsSelect an object to expand

itemsarray of SeatDataRequired7 fields
items
- idnumberRequired when parent is presentField path: items[].id
- namestringRequired when parent is presentField path: items[].name
- emailstringRequired when parent is presentField path: items[].email
  Can be null
- statusstringRequired when parent is presentField path: items[].status
  Allowed values: "pending", "accepted", "expired", "awaiting_activation"
- memberIdstringRequired when parent is presentField path: items[].memberId
- memberDataMemberPersonalInfoRequired when parent is presentField path: items[].memberData20 fields
  items[].memberData
  - idstringRequired when parent is presentField path: items[].memberData.id
  - fullNamestringRequired when parent is presentField path: items[].memberData.fullName
  - nickNamestringRequired when parent is presentField path: items[].memberData.nickName
  - createdAtstring (date-time)Required when parent is presentField path: items[].memberData.createdAt
  - avatarstringRequired when parent is present
- expiresAtstringRequired when parent is presentField path: items[].expiresAt
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

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

Schema ExampleSeatDataPaginated

200 · application/json

{
  "items": [
    {}
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 13 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status200 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema Examplearray of IpRangeDto

2 top-level fields

ipRangestringRequired when parent is present
labelstring

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

Schema Examplearray of IpRangeDto

200 · application/json

[
  {
    "ipRange": "string",
    "label": "string"
  }
]

Example · 6 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest, tooManyIpRanges, duplicateIpRangeInRequest, ipRangesNotAllowedOnThisProduct, invalidIpRangeFormat, ipRangeTooBroad

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "tooManyIpRanges"

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Join selected available subscriptions (create product seats) (401).

Schema ExampleErrorResponse

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 404

Status200 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/product/{id}/ip-ranges' \
  --request PUT \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "ipRanges": [
    {}
  ]
}'

Responses 400

Status200 400 401 403 404 500application/json

badRequest, ipRangesNotAllowedOnThisProduct

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "ipRangesNotAllowedOnThisProduct"
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 Join selected available subscriptions (create product seats) (401).

Schema ExampleErrorResponse

401 · application/json

{
  "messageCode": "unauthorized",
  "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 mypage cards settings of a tenant (401).

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

ipRangeNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "ipRangeNotFound"
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": "ipRangeNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

fullName

string

Schema ExampleCreateAdditionalMemberDto

application/json

{
  "fullName": "<fullName>",
  "memberPackageProductId": 1,
  "email": "user@example.com",
  "birthDate": "<birthDate>",
  "nickName": "string",
  "phone": "<phone>",
  "countryCode": "string",
  "isCompany": true,
  "companyName": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationNo": "string",
    "companyName": "string",
    "invoiceReference": "string"
  },
  "customPropertyValues": {}
}

Example · 25 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleMemberPersonalInfo

Same fields as Get logged in member personal info (200).

Schema ExampleMemberPersonalInfo

201 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, alreadyExists, seatLimitReached, phoneAlreadyVerified

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "alreadyExists", "seatLimitReached", "phoneAlreadyVerified"

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound, productNotFound

Schema ExampleErrorResponse

Same fields as Join selected available subscriptions (create product seats) (404).

Schema ExampleErrorResponse

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/product/{id}/create-member' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "<fullName>",
  "memberPackageProductId": 1,
  "email": "user@example.com",
  "birthDate": "<birthDate>",
  "nickName": "string",
  "phone": "<phone>",
  "countryCode": "string",
  "isCompany": true,
  "companyName": "string",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationNo": "string",
    "companyName": "string",
    "invoiceReference": "string"
  },
  "customPropertyValues": {}
}'

Schema ExampleCreateGiftReceiverDto

application/json

{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "phone": "<phone>",
  "memberPackageProductId": 1
}

Example · 6 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleMemberPersonalInfo

Same fields as Get logged in member personal info (200).

Schema ExampleMemberPersonalInfo

201 · application/json

{
  "id": "string",
  "fullName": "<fullName>",
  "nickName": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "avatar": "string",
  "countryCode": "string",
  "birthDate": "<birthDate>",
  "deleteAfterExpiration": true,
  "isCompany": true,
  "companyName": "string",
  "organizationNo": "string",
  "customPropertyValues": {},
  "emailVerified": "string",
  "phoneVerified": true,
  "memberNumber": 0,
  "userId": 0,
  "emailStatus": "scheduled",
  "email": "user@example.com",
  "phone": "<phone>",
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "string",
    "companyName": "string",
    "organizationNo": "string",
    "invoiceReference": "string",
    "isSynced": true,
    "lastSyncedAt": "2019-08-24T14:15:22Z"
  }
}

Example · 35 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, alreadyExists, seatLimitReached, invitationAlreadyAccepted, invitationAlreadySent, phoneAlreadyVerified

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest",

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound, memberPackageProductNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "notFound", "memberPackageProductNotFound"

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/product/{id}/create-gift-receiver' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "<fullName>",
  "email": "user@example.com",
  "phone": "<phone>",
  "memberPackageProductId": 1
}'

application/json

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 409 500application/json

badRequest, nextRenewalDateRequired, subscriptionChangeBlockedVippsChargeWindow, nextOrderDateMustBeAfterToday

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "nextRenewalDateRequired", "subscriptionChangeBlockedVippsChargeWindow", "nextOrderDateMustBeAfterToday"
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 409 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 409 500application/json

notFound, memberPackageNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "notFound", "memberPackageNotFound"
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": "notFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 409

Status200 400 401 403 404 409 500application/json

autoRenewRequiresStoredPaymentMethod

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

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

409 · application/json

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

Example · 7 linesShow full heightShow compact view

boolean

Schema ExampleUpdateMemberPackageDto

application/json

{
  "autoRenew": true,
  "nextRenewal": "2019-08-24T14:15:22Z",
  "scheduledActivationDate": "2019-08-24T14:15:22Z"
}

Example · 5 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

This response has no body.

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a 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 mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status200 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/{id}/activation-date' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "autoRenew": true,
  "nextRenewal": "2019-08-24T14:15:22Z",
  "scheduledActivationDate": "2019-08-24T14:15:22Z"
}'

idnumberRequired
namestringRequired
emailstringRequired
Can be null
statusstringRequired
Allowed values: "pending", "accepted", "expired", "awaiting_activation"
memberIdstringRequired
memberDataMemberPersonalInfoRequired20 fields
memberData
- idstringRequiredField path: memberData.id
- fullNamestringRequiredField path: memberData.fullName
- nickNamestringRequiredField path: memberData.nickName
- createdAtstring (date-time)RequiredField path: memberData.createdAt
- avatarstringRequiredField path: memberData.avatar
- countryCodestringField path: memberData.countryCode
- birthDatestring (date-time)RequiredField path: memberData.birthDate
- deleteAfterExpirationbooleanRequiredField path: memberData.deleteAfterExpiration
- isCompanybooleanRequiredField path: memberData.isCompany
- companyNamestringRequiredField path: memberData.companyName
- organizationNostringRequiredField path: memberData.organizationNo
- customPropertyValuesobjectRequiredField path: memberData.customPropertyValues
- emailVerifiedstringField path: memberData.emailVerified
- phoneVerifiedbooleanRequiredField path: memberData.phoneVerified
- memberNumbernumberRequiredField path: memberData.memberNumber
- userIdnumberRequiredField path: memberData.userId
- emailStatusSENDGRID_MAIL_EVENTSField path: memberData.emailStatus
  Field details
  Allowed values: "scheduled", "processed", "dropped", "deferred", "bounce", "hard_bounce", "soft_bounce", "spamreport", "delivered", "unsubscribe", "group_unsubscribe", "group_resubscribe", "open", "failed", "click", "skipped_bounced"
- emailstring (email)RequiredField path: memberData.email
- phonestringRequiredField path: memberData.phone
- addressProfileAddressRequiredField path: memberData.address12 fields
  memberData.address
  - line1stringRequiredField path: memberData.address.line1
  - line2stringRequiredField path: memberData.address.line2
  - citystringRequiredField path: memberData.address.city
  - postCodestringRequiredField path: memberData.address.postCode
  - countrystringRequiredField path: memberData.address.country
expiresAtstringRequired

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

Schema ExampleSeatData

200 · application/json

{
  "id": 0,
  "name": "string",
  "email": "string",
  "status": "pending",
  "memberId": "string",
  "memberData": {
    "id": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "avatar": "string",
    "countryCode": "string",
    "birthDate": "<birthDate>",
    "deleteAfterExpiration": true,
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "customPropertyValues": {},
    "emailVerified": "string",
    "phoneVerified": true,
    "memberNumber": 0,
    "userId": 0,
    "emailStatus": "scheduled",
    "email": "user@example.com",
    "phone": "<phone>",
    "address": {}
  },
  "expiresAt": "string"
}

Example · 30 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleUpdateMemberDto

application/json

{
  "fullName": "<fullName>",
  "deleteAfterExpiration": true,
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationNo": "string",
    "companyName": "string",
    "invoiceReference": "string"
  },
  "email": "user@example.com",
  "birthDate": "<birthDate>",
  "nickName": "string",
  "phone": "<phone>",
  "countryCode": "string",
  "isCompany": true,
  "companyName": "string",
  "customPropertyValues": {}
}

Example · 25 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleSeatData

Same fields as Get product seat details (200).

Schema ExampleSeatData

200 · application/json

{
  "id": 0,
  "name": "string",
  "email": "string",
  "status": "pending",
  "memberId": "string",
  "memberData": {
    "id": "string",
    "fullName": "<fullName>",
    "nickName": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "avatar": "string",
    "countryCode": "string",
    "birthDate": "<birthDate>",
    "deleteAfterExpiration": true,
    "isCompany": true,
    "companyName": "string",
    "organizationNo": "string",
    "customPropertyValues": {},
    "emailVerified": "string",
    "phoneVerified": true,
    "memberNumber": 0,
    "userId": 0,
    "emailStatus": "scheduled",
    "email": "user@example.com",
    "phone": "<phone>",
    "address": {}
  },
  "expiresAt": "string"
}

Example · 30 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest, phoneAlreadyVerified, alreadyExists

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "phoneAlreadyVerified", "alreadyExists"
messagestring

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status200 400 401 403 404 500application/json

notPackageOwner

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "notPackageOwner"
messagestring

Responses 404

Status200 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/seats/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "fullName": "<fullName>",
  "deleteAfterExpiration": true,
  "address": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postCode": "string",
    "country": "string",
    "name": "string",
    "email": "user@example.com",
    "organizationNo": "string",
    "companyName": "string",
    "invoiceReference": "string"
  },
  "email": "user@example.com",
  "birthDate": "<birthDate>",
  "nickName": "string",
  "phone": "<phone>",
  "countryCode": "string",
  "isCompany": true,
  "companyName": "string",
  "customPropertyValues": {}
}'

array of MemberPackageProductSeatRecipientProductsResponseDto

Schema Examplearray of MemberPackageProductSeatRecipientProductsResponseDto

200 · application/json

[
  {
    "memberPackageProductId": 123,
    "productName": "Premium Subscription"
  }
]

Example · 6 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleMemberPackageProductSeat

14 top-level fieldsSelect an object to expand

memberPackageProductIdnumberRequired
memberIdstringRequired
emailstringRequired
Can be null
acceptedbooleanRequired
acceptedAtstring (date-time)Required
expiresAtstring (date-time)Required
uuidstringRequired
memberPackageProductMemberPackageProductRequired20 fields
memberPackageProduct
- memberPackageIdnumberRequiredField path: memberPackageProduct.memberPackageId
- productIdnumberRequiredField path: memberPackageProduct.productId
- pricenumberRequiredField path: memberPackageProduct.price
- recurringPricenumberRequiredField path: memberPackageProduct.recurringPrice
- quantitynumberRequired
memberMemberRequired21 fields
member
- userIdnumberRequiredField path: member.userId
  Can be null
- memberNumbernumberRequiredField path: member.memberNumber
  Can be null
- tenantIdnumberRequiredField path: member.tenantId
- externalIdstringRequiredField path: member.externalId
  Can be null
- fullNamestring
idnumberRequired
createdAtstring (date-time)Required
updatedAtstring (date-time)Required
deletedAtstring (date-time)Required
metaDataobjectRequired

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

Schema ExampleMemberPackageProductSeat

201 · application/json

Responses 400

Status201 400 401 403 404 500application/json

badRequest, cannotInviteYourself, cannotAssignToTheOwner, invitationLimitReached, invitationAlreadyAccepted, invitationAlreadySent

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "cannotInviteYourself", "cannotAssignToTheOwner", "invitationLimitReached", "invitationAlreadyAccepted", "invitationAlreadySent"

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound, memberPackageProductNotFound

Schema ExampleErrorResponse

Same fields as Create gift receiver for a product seat (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/seats/invite \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "id": 1
}'

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleMemberPackageProductSeat

Same fields as Invite member to a product seat (201).

Schema ExampleMemberPackageProductSeat

201 · application/json

{
  "memberPackageProductId": 0,
  "memberId": "string",
  "email": "string",
  "accepted": true,
  "acceptedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "uuid": "string",
  "memberPackageProduct": {
    "memberPackageId": 0,
    "productId": 0,
    "price": 0,
    "recurringPrice": 0,
    "quantity": 0,
    "hasAccess": true,
    "shippingCountry": "string",
    "shippingProvider": "Helthjem",
    "allowDistributorToUpdateDeliveryAddress": true,
    "memberPackageProductEmailDomains": [],
    "memberPackageProductIps": [],
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "product": {
      "properties": {},
      "shippingCharges": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packageProducts": [],
      "memberPackageProducts": [],
      "orderItem": [],
      "productContents": [],
      "metaData": {}
    },
    "seats": [],
    "recipients": [],
    "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": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 75 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, invitationLimitReached, invitationAlreadyAccepted, invitationAlreadySent, cannotInviteYourself, cannotAssignToTheOwner

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "invitationLimitReached", "invitationAlreadyAccepted", "invitationAlreadySent", "cannotInviteYourself", "cannotAssignToTheOwner"

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound, memberPackageProductNotFound

Schema ExampleErrorResponse

Same fields as Create gift receiver for a product seat (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/seats/{seatId}/resend' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com"
}'

MemberPackageProductSeat

Schema ExampleMemberPackageProductSeat

201 · application/json

{
  "memberPackageProductId": 0,
  "memberId": "string",
  "email": "string",
  "accepted": true,
  "acceptedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "uuid": "string",
  "memberPackageProduct": {
    "memberPackageId": 0,
    "productId": 0,
    "price": 0,
    "recurringPrice": 0,
    "quantity": 0,
    "hasAccess": true,
    "shippingCountry": "string",
    "shippingProvider": "Helthjem",
    "allowDistributorToUpdateDeliveryAddress": true,
    "memberPackageProductEmailDomains": [],
    "memberPackageProductIps": [],
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "product": {
      "properties": {},
      "shippingCharges": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packageProducts": [],
      "memberPackageProducts": [],
      "orderItem": [],
      "productContents": [],
      "metaData": {}
    },
    "seats": [],
    "recipients": [],
    "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": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 75 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, invitationAlreadyAccepted, invitationExpired, seatLimitReached

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "invitationAlreadyAccepted", "invitationExpired", "seatLimitReached"
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

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 404 500application/json

invalidMember

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "invalidMember"
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": "invalidMember",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status201 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

MemberPackageProductSeat

Schema ExampleMemberPackageProductSeat

201 · application/json

{
  "memberPackageProductId": 0,
  "memberId": "string",
  "email": "string",
  "accepted": true,
  "acceptedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "uuid": "string",
  "memberPackageProduct": {
    "memberPackageId": 0,
    "productId": 0,
    "price": 0,
    "recurringPrice": 0,
    "quantity": 0,
    "hasAccess": true,
    "shippingCountry": "string",
    "shippingProvider": "Helthjem",
    "allowDistributorToUpdateDeliveryAddress": true,
    "memberPackageProductEmailDomains": [],
    "memberPackageProductIps": [],
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "product": {
      "properties": {},
      "shippingCharges": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packageProducts": [],
      "memberPackageProducts": [],
      "orderItem": [],
      "productContents": [],
      "metaData": {}
    },
    "seats": [],
    "recipients": [],
    "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": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 75 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, invitationAlreadyAccepted, invitationExpired, seatLimitReached

Schema ExampleErrorResponse

Same fields as Accept invitation to a product seat (400).

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 404 500application/json

invalidMember

Schema ExampleErrorResponse

Same fields as Accept invitation to a product seat (403).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status201 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleMemberAddressDto

application/json

{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}

Example · 13 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleProfileAddress

12 top-level fields

line1stringRequired
line2stringRequired
citystringRequired
postCodestringRequired
countrystringRequired
namestringRequired
emailstringRequired
companyNamestringRequired
organizationNostringRequired
invoiceReferencestring
isSyncedboolean
lastSyncedAtstring (date-time)

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

Schema ExampleProfileAddress

201 · application/json

{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "string",
  "companyName": "string",
  "organizationNo": "string",
  "invoiceReference": "string",
  "isSynced": true,
  "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Example · 14 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (400).

Schema ExampleErrorResponse

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/{id}/invoice-address' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}'

application/json

{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}

Example · 13 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleProfileAddress

Same fields as Add invoice address of a subscribed product (201).

Schema ExampleProfileAddress

200 · application/json

{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "string",
  "companyName": "string",
  "organizationNo": "string",
  "invoiceReference": "string",
  "isSynced": true,
  "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Example · 14 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (400).

Schema ExampleErrorResponse

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status200 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/{id}/invoice-address' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}'

MemberAddressDto

application/json

{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}

Example · 13 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleDeliveryAddress

14 top-level fields

idnumberRequired
routestring
Can be nullThe DI carrier route for this address.
line1stringRequired
line2stringRequired
citystringRequired
postCodestringRequired
countrystringRequired
namestringRequired
emailstringRequired
companyNamestringRequired
organizationNostringRequired
invoiceReferencestring
isSyncedboolean
lastSyncedAtstring (date-time)

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

Schema ExampleDeliveryAddress

201 · application/json

{
  "id": 0,
  "route": "string",
  "line1": "string",
  "line2": "string",
  "city": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "string",
  "companyName": "string",
  "organizationNo": "string",
  "invoiceReference": "string",
  "isSynced": true,
  "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Example · 16 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (400).

Schema ExampleErrorResponse

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/product/{id}/delivery-address' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}'

Responses 400

Status200 400 401 403 404 500application/json

badRequest, alreadyActivated, alreadyDeactivated, seatLimitReached

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "alreadyActivated", "alreadyDeactivated", "seatLimitReached"
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 mypage cards settings of a tenant (401).

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

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/product/{id}/owner-access/{activate}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>'

application/json

Schema ExampleDeliveryAddress

Same fields as Add delivery address of a subscribed product (201).

Schema ExampleDeliveryAddress

200 · application/json

{
  "id": 0,
  "route": "string",
  "line1": "string",
  "line2": "string",
  "city": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "string",
  "companyName": "string",
  "organizationNo": "string",
  "invoiceReference": "string",
  "isSynced": true,
  "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Example · 16 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}

Example · 13 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

Schema ExampleDeliveryAddress

Same fields as Add delivery address of a subscribed product (201).

Schema ExampleDeliveryAddress

200 · application/json

{
  "id": 0,
  "route": "string",
  "line1": "string",
  "line2": "string",
  "city": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "string",
  "companyName": "string",
  "organizationNo": "string",
  "invoiceReference": "string",
  "isSynced": true,
  "lastSyncedAt": "2019-08-24T14:15:22Z"
}

Example · 16 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (400).

Schema ExampleErrorResponse

Responses 401

Status200 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status200 400 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

Responses 500

Status200 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/product/{productId}/delivery-address/{addressId}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "line1": "string",
  "line2": "string",
  "city": "string",
  "state": "string",
  "postCode": "string",
  "country": "string",
  "name": "string",
  "email": "user@example.com",
  "organizationNo": "string",
  "companyName": "string",
  "invoiceReference": "string"
}'

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/product/{id}/delivery-address/{addressId}' \
  --request DELETE \
  --header 'Authorization: Bearer <token>'

Schema Examplearray of MemberConsentDto

200 · application/json

[
  {
    "id": 0,
    "updatedAt": "2019-08-24T14:15:22Z",
    "title": "string",
    "description": "string",
    "image": "string",
    "showOnCheckoutPage": true,
    "showOnMyPage": true,
    "status": {},
    "sortOrder": 0,
    "frequency": "string",
    "newsletterProviderConfigId": 0,
    "consentStatus": "string",
    "purpose": "marketing_and_newsletter",
    "visibility": "subscriber"
  }
]

Example · 18 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

memberNotFound

Schema ExampleErrorResponse

Same fields as Get logged in member info with content access (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 200

Status200 400 401 403 500 502application/json

Schema ExampleMemberConsentDto

14 top-level fields

idnumberRequired
updatedAtstring (date-time)Required
titlestringRequired
descriptionstringRequired
imagestringRequired
showOnCheckoutPagebooleanRequired
showOnMyPagebooleanRequired
statusobjectRequired
sortOrdernumberRequired
frequencystringRequired
newsletterProviderConfigIdnumberRequired
Can be null
consentStatusstringRequired
purposestringRequired
Allowed values: "marketing_and_newsletter", "consent"
visibilitystringRequired
Allowed values: "subscriber", "nonSubscriber", "all"

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

Schema ExampleMemberConsentDto

200 · application/json

{
  "id": 0,
  "updatedAt": "2019-08-24T14:15:22Z",
  "title": "string",
  "description": "string",
  "image": "string",
  "showOnCheckoutPage": true,
  "showOnMyPage": true,
  "status": {},
  "sortOrder": 0,
  "frequency": "string",
  "newsletterProviderConfigId": 0,
  "consentStatus": "string",
  "purpose": "marketing_and_newsletter",
  "visibility": "subscriber"
}

Example · 16 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500 502application/json

badRequest, invalidConsent, mailchimpBadRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "invalidConsent", "mailchimpBadRequest"
messagestring

Responses 401

Status200 400 401 403 500 502application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status200 400 401 403 500 502application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 500

Status200 400 401 403 500 502application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 502

Status200 400 401 403 500 502application/json

newsletterProviderError

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "newsletterProviderError"
messagestring

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/consents/toggle/{id}' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "mypage",
  "reference": "string",
  "note": "string"
}'

boolean

Responses 401

Status201 401 403 404 500 502application/json

unauthorized

Responses 404

Status201 401 403 404 500 502application/json

memberNotFound

Responses 502

Status201 401 403 404 500 502application/json

newsletterProviderError

Schema ExampleErrorResponse

502 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleChangeSubscriptionResponse

2 top-level fields

subscriptionChangeIdnumberRequired
orderIdnumber

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

Schema ExampleChangeSubscriptionResponse

201 · application/json

{
  "subscriptionChangeId": 0,
  "orderId": 0
}

Example · 4 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

badRequest, subscriptionChangeBlockedNotActive, subscriptionChangeBlockedPastDue, subscriptionChangeBlockedOnRenewalDay, subscriptionChangeBlockedVippsChargeCreated, subscriptionChangeBlockedVippsChargeWindow, subscriptionChangeBlockedInvoicePaidNextPeriod, subscriptionChangeBlockedInvoiceUnpaidCurrentPeriod, seatTransferTargetPlanNotGroupCapable, seatTransferMappingRequired, seatTransferDuplicateSource, seatTransferTargetNotInPlan, seatTransferTargetNotDigital, seatTransferInsufficientCapacity

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound, memberPackageNotFound

Schema ExampleErrorResponse

Same fields as Toggle auto renewal of subscription (404).

Schema ExampleErrorResponse

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscriptions/{id}/change' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "planId": 0,
  "isImmediate": true,
  "products": [
    {}
  ],
  "seatTransferMap": [
    {}
  ]
}'

17 top-level fieldsSelect an object to expand

idnumberRequired
currentPlanNamestringRequired
newPlanNamestringRequired
currentProductsarray of ProductPackageRequired15 fields
currentProducts
- circulationTypeCIRCULATION_TYPEField path: currentProducts[].circulationType
  Can be nullAllowed values: "subscription", "single_copy"
- idnumberRequired when parent is presentField path: currentProducts[].id
- namestringRequired when parent is presentField path: currentProducts[].name
- productIdnumberRequired when parent is presentField path: currentProducts[].productId
- productCategorystringRequired when parent is presentField path: currentProducts[].productCategory
  Allowed values: "digital_subscription", "physical_subscription", "physical", "event_ticket", "PHYSICAL_PRODUCT"
- pricenumberRequired when parent is presentField path: currentProducts[].price
- recurringPricenumberRequired when parent is presentField path: currentProducts[].recurringPrice
- quantitynumberRequired when parent is presentField path: currentProducts[].quantity
- hasAccessbooleanRequired when parent is presentField path: currentProducts[].hasAccess
- isOptionalbooleanRequired when parent is presentField path: currentProducts[].isOptional
- shippingCountrystringRequired when parent is presentField path: currentProducts[].shippingCountry
- shippingChargesarray of ShippingChargeRequired when parent is presentField path: currentProducts[].shippingCharges2 fields
  currentProducts[].shippingCharges
  - countrystringRequired when parent is presentField path: currentProducts[].shippingCharges[].country
  - chargenumberRequired when parent is presentField path: currentProducts[].shippingCharges[].charge
- shippingCountriesarray of stringRequired when parent is presentField path: currentProducts[].shippingCountries
- shippingPricenumberRequired when parent is presentField path: currentProducts[].shippingPrice
- groupInfoGroupSubscriptionResponseRequired when parent is presentField path: currentProducts[].groupInfo11 fields
  currentProducts[].groupInfo
  - ownerHasAccessbooleanRequired when parent is presentField path: currentProducts[].groupInfo.ownerHasAccess
    Default: false
  - seatsAllowednumberRequired when parent is presentField path: currentProducts[].groupInfo.seatsAllowed
    Default: 0
  - seatsActivenumberRequired when parent is presentField path: currentProducts[].groupInfo.seatsActive
    Default: 0
newProductsarray of ProductPackageRequired15 fields
newProducts
- circulationTypeCIRCULATION_TYPEField path: newProducts[].circulationType
  Can be nullAllowed values: "subscription", "single_copy"
- idnumberRequired when parent is presentField path: newProducts[].id
- namestringRequired when parent is presentField path: newProducts[].name
- productIdnumberRequired when parent is presentField path: newProducts[].productId
- productCategorystring
currentPaymentProviderInfoPaymentInfoRequired7 fields
currentPaymentProviderInfo
- stripeCardInfoStripeCardInfoRequiredField path: currentPaymentProviderInfo.stripeCardInfo5 fields
  currentPaymentProviderInfo.stripeCardInfo
  - brandstringRequiredField path: currentPaymentProviderInfo.stripeCardInfo.brand
  - expMonthnumberRequiredField path: currentPaymentProviderInfo.stripeCardInfo.expMonth
  - expYear
currentBillingPeriodBillingPeriodInfoRequired2 fields
currentBillingPeriod
- billingPeriodstringRequiredField path: currentBillingPeriod.billingPeriod
- customBillingPeriodBillingPeriodDetailsRequiredField path: currentBillingPeriod.customBillingPeriodNested fields omitted: field limit.
newBillingPeriodBillingPeriodInfoRequired2 fields
newBillingPeriod
- billingPeriodstringRequiredField path: newBillingPeriod.billingPeriod
- customBillingPeriodBillingPeriodDetailsRequiredField path: newBillingPeriod.customBillingPeriodNested fields omitted: field limit.
currentPeriodStartstring (date-time)Required
nextRenewalstring (date-time)Required
newPeriodStartstring (date-time)Required
changeInPricenumberRequired
currentRecurringPricenumberRequired
nextRenewalPricenumberRequired
autoRenewbooleanRequired
newPackageAutoRenewbooleanRequired
orderIdnumberRequired

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

Schema ExampleChangeSubscriptionDetails

200 · application/json

{
  "id": 0,
  "currentPlanName": "string",
  "newPlanName": "string",
  "currentProducts": [
    {
      "shippingCharges": [],
      "shippingCountries": []
    }
  ],
  "newProducts": [
    {
      "shippingCharges": [],
      "shippingCountries": []
    }
  ],
  "currentPaymentProviderInfo": {
    "stripeCardInfo": {},
    "isLink": true,
    "netsCardInfo": {},
    "swedbankpayCardInfo": {},
    "vippsPaymentInfoWithDueCharge": {},
    "eInvoicePaymentInfo": {},
    "externalPaymentInfo": {}
  },
  "currentBillingPeriod": {
    "billingPeriod": "string",
    "customBillingPeriod": {}
  },
  "newBillingPeriod": {
    "billingPeriod": "string",
    "customBillingPeriod": {}
  },
  "currentPeriodStart": "2019-08-24T14:15:22Z",
  "nextRenewal": "2019-08-24T14:15:22Z",
  "newPeriodStart": "2019-08-24T14:15:22Z",
  "changeInPrice": 0,
  "currentRecurringPrice": 0,
  "nextRenewalPrice": 0,
  "autoRenew": true,
  "newPackageAutoRenew": true,
  "orderId": 0
}

Example · 43 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest, invalidStatus

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "invalidStatus"
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 mypage cards settings of a tenant (401).

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

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

availableSubscriptionsToJoinarray of MemberPackageProductRequired when parent is present20 fields

[].availableSubscriptionsToJoin

memberPackageIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageId
productIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].productId
pricenumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].price
recurringPricenumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].recurringPrice
quantitynumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].quantity
hasAccessbooleanRequired when parent is presentField path: [].availableSubscriptionsToJoin[].hasAccess
shippingCountrystringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].shippingCountry
shippingProviderstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].shippingProvider
Allowed values: "Helthjem", "Bring - Posten", "Distribution Innovation"
allowDistributorToUpdateDeliveryAddressbooleanRequired when parent is presentField path: [].availableSubscriptionsToJoin[].allowDistributorToUpdateDeliveryAddress
memberPackageProductEmailDomainsarray of MemberPackageProductEmailDomainRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains9 fields
[].availableSubscriptionsToJoin[].memberPackageProductEmailDomains
- memberPackageProductIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].memberPackageProductId
- emailDomainstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].emailDomain
memberPackageProductIpsarray of MemberPackageProductIpRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps10 fields
[].availableSubscriptionsToJoin[].memberPackageProductIps
- memberPackageProductIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].memberPackageProductId
- ipRangestringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].ipRange
- labelstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].label
memberPackageMemberPackageRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageNested fields omitted: field limit.
productProductRequired when parent is presentField path: [].availableSubscriptionsToJoin[].productNested fields omitted: field limit.
seatsarray of MemberPackageProductSeatRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats14 fields
[].availableSubscriptionsToJoin[].seats
- memberPackageProductIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].memberPackageProductId
- memberIdstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].memberId
- emailstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].email
  Can be null
recipientsarray of MemberPackageProductRecipientRequired when parent is presentField path: [].availableSubscriptionsToJoin[].recipientsNested fields omitted: field limit.
idnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].id
createdAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].createdAt
updatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].updatedAt
deletedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].deletedAt
metaDataobjectRequired when parent is presentField path: [].availableSubscriptionsToJoin[].metaData

Schema Examplearray of MissingInfoResponse

200 · application/json

[
  {
    "missingInfoType": "member_details",
    "alertIndex": "string",
    "missingFields": [],
    "invitedMemberInfo": {},
    "memberNotInvitedInfo": {
      "subscriptionProductInfo": []
    },
    "giftReceiverNotAddedInfo": {
      "subscriptionProductInfo": []
    },
    "activationDateMissingInfo": {},
    "availableSubscriptionsToJoin": [],
    "buyNewSubscriptionPackageSlug": "string"
  }
]

Example · 17 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema Examplearray of LoginAccountsResponse

200 · application/json

[
  {
    "id": "string",
    "provider": "string",
    "providerAccountId": "string",
    "email": "string",
    "phone": "<phone>",
    "userId": 0
  }
]

Example · 10 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Responses 404

Status200 401 403 404 500application/json

notFound

Example requestcurl

curl

curl https://api.subrite.no/api/v1/members/profile/subscription-plan/price-by-quantity \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "planId": 1,
  "products": [
    {}
  ],
  "memberPackageId": 0
}'

Responses 404

Status200 401 403 404 500application/json

notFound

Responses

5 status codes

Responses 201

Status201 401 403 404 500application/json

Schema ExampleSubscriptionActionHelpTextResponse

1 top-level field

helpTextstringRequired

1 documented field · Scroll to see moreShow full heightShow compact view

Schema ExampleSubscriptionActionHelpTextResponse

201 · application/json

{
  "helpText": "string"
}

Example · 3 linesShow full heightShow compact view

Responses 401

Status201 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Responses 404

Status201 401 403 404 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

Responses 500

Status201 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/members/profile/subscription-action-help-text/{id}' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "language": "en",
  "autoRenew": true,
  "isRestart": true
}'

Responses 401

Status204 401 403 404 409 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get mypage cards settings of a tenant (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 403

Status204 401 403 404 409 500application/json

forbidden

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

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

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 404

Status204 401 403 404 409 500application/json

notFound

Schema ExampleErrorResponse

Same fields as Get logged in member subscriptions (404).

Schema ExampleErrorResponse

404 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 409

Status204 401 403 404 409 500application/json

storedPaymentMethodRemovalNotAllowed

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

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

409 · application/json

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

Example · 7 linesShow full heightShow compact view

MemberPackageProduct

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

string

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

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

array of FieldError

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

[
  {
    "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
  }
]

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

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

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

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

, "duplicateIpRangeInRequest"

, "ipRangesNotAllowedOnThisProduct"

, "invalidIpRangeFormat"

, "ipRangeTooBroad"

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

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

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

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

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

"alreadyExists"

, "seatLimitReached"

, "invitationAlreadyAccepted"

, "invitationAlreadySent"

, "phoneAlreadyVerified"

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

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

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

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

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

{
  "memberPackageProductId": 0,
  "memberId": "string",
  "email": "string",
  "accepted": true,
  "acceptedAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z",
  "uuid": "string",
  "memberPackageProduct": {
    "memberPackageId": 0,
    "productId": 0,
    "price": 0,
    "recurringPrice": 0,
    "quantity": 0,
    "hasAccess": true,
    "shippingCountry": "string",
    "shippingProvider": "Helthjem",
    "allowDistributorToUpdateDeliveryAddress": true,
    "memberPackageProductEmailDomains": [],
    "memberPackageProductIps": [],
    "memberPackage": {
      "memberPackageProducts": [],
      "orders": [],
      "changes": [],
      "histories": [],
      "metaData": {}
    },
    "product": {
      "properties": {},
      "shippingCharges": [],
      "entityTags": [],
      "subscriptionPlanProducts": [],
      "packageProducts": [],
      "memberPackageProducts": [],
      "orderItem": [],
      "productContents": [],
      "metaData": {}
    },
    "seats": [],
    "recipients": [],
    "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": {}
  },
  "id": 0,
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Schema ExampleErrorResponse

502 · application/json

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

Example · 7 linesShow full heightShow compact view

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

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

number

updatedBy

number

{
  "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": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

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

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

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

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

Get mypage cards settings of a tenant#

Parameters

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Get subscriptions available to join based on email domain#

Responses

Responses 200

Join selected available subscriptions (create product seats)#

Request body

Get logged in member personal info#

Responses

Responses 200

Update logged in member profile#

Request body

Get logged in member subscriptions#

Parameters

Responses

Responses 200

Get logged in member invoices#

Responses

Responses 200

Get logged in member orders#

Parameters

Get logged in member info with content access#

Responses

Responses 200

Get logged in members basic info and active packages#

Responses

Responses 200

Set logged in member avatar or profile picture#

Request body

Request email pre-verification#

Request body

Update email#

Request body

Request phone pre-verification#

Request body

Update phone#

Request body

Request deletion of a member by its own#

Responses

Responses 201

Get member subscription details#

Parameters

Responses

Responses 200

Get subscription plans by filters#

Parameters

Get subscription plan settings details#

Parameters

Responses

Responses 200

Get subscribed product details#

Parameters

Responses

Responses 200

Get paginated seats for a subscribed product#

Parameters

Replace the full IP-range list for a subscribed product (full snapshot)#

Parameters

Request body

Remove a specific IP range from a subscribed product. The :ipRange path segment is the canonical CIDR (URL-encode "/" as %2F).#

Parameters

Responses

Responses 200

Create additional member for a product seat#

Parameters

Request body

Create gift receiver for a product seat#

Parameters

Request body

Get invoice of a order#

Parameters

Responses

Responses 200

Responses 401