Checkout State | Subrite

Checkout State

Endpoints for Checkout State

ReferenceUpdated October 13, 2026View as Markdown

GET/api/v1/checkout-state/{uuid}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Responses

6 status codes

Responses 200

Status200 401 403 404 410 500application/json

Schema ExampleCheckoutStateResponse

11 top-level fieldsSelect an object to expand

uuidstringRequired
statusCHECKOUT_STATE_STATUSRequired
Field details
Allowed values: "created", "payment_completed", "payment_failed", "member_info", "additional_member_info", "physical_product_info", "gift_receiver_info", "gift_receiver_delivery_info", "consent_info", "completed", "not_set", "pending"
paymentDataobjectRequired
memberDataMemberPersonalInfo

Responses 401

Status200 401 403 404 410 500application/json

unauthorized

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired

Responses 403

Status200 401 403 404 410 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 404

Status200 401 403 404 410 500application/json

notFound

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 410

Status200 401 403 404 410 500application/json

expired

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status200 401 403 404 410 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}' \
  --header 'Authorization: Bearer <token>'

Try it

check account and create checkout state for existing member#

POST/api/v1/checkout-state/account-check

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaAccountCheckDto

3 top-level fieldsSelect an object to expand

emailstring (email)Optional
phonestringOptional
maxLength: 20

PATCH/api/v1/checkout-state/{uuid}/account-check

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

SchemaAccountCheckDto

Same fields as check account and create checkout state for existing member (Request body).

Responses

5 status codes

Responses 200

PATCH/api/v1/checkout-state/{uuid}/update-profile

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

Schema ExampleUpdateMemberPersonalInfo

11 top-level fieldsSelect an object to expand

fullNamestringOptional

PATCH/api/v1/checkout-state/{uuid}/populate-group-and-product

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Invite member to a product seat#

POST/api/v1/checkout-state/{uuid}/invite

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

Schema ExampleInviteSeatDto

2 top-level fields

emailstring (email)Required
idnumber

Create additional member for a product seat#

POST/api/v1/checkout-state/{uuid}/create-additional-member

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

Schema ExampleCreateAdditionalMemberDto

11 top-level fieldsSelect an object to expand

fullNamestring

Complete additional members creation step#

POST/api/v1/checkout-state/{uuid}/complete-additional-member

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Responses

5 status codes

Responses 201

Status201 401 403 404 500application/json

Assign default gift receiver data and store it in the checkout state#

POST/api/v1/checkout-state/{uuid}/assign-default-gift-receivers

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Responses

4 status codes

Responses 201

Status201 401 403 500application/json

Create gift receiver for a product seat#

POST/api/v1/checkout-state/{uuid}/create-gift-receiver

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

Schema ExampleCreateGiftReceiverDto

4 top-level fields

fullNamestringRequired

Complete gift receiver step#

POST/api/v1/checkout-state/{uuid}/complete-gift-receiver

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

Schema ExampleCompleteGiftReceiverDto

1 top-level field

scheduledActivationDatestring (date-time)Optional

Update gift receiver address of a physical product seat#

POST/api/v1/checkout-state/{uuid}/update-gift-receiver-addresses

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

SchemaSaveDeliveryAddressDto

1 top-level fieldSelect an object to expand

Save delivery address of a physical product seat#

POST/api/v1/checkout-state/{uuid}/save-delivery-addresses

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Request body

Required bodyapplication/json

SchemaSaveDeliveryAddressDto

Same fields as Update gift receiver address of a physical product seat (Request body).

Responses

6 status codes

Responses 201

POST/api/v1/checkout-state/{uuid}/complete-consent

Authentication: Bearer token (JWT)

Parameters

Path parameters1

uuidstringRequired

Responses

5 status codes

Responses 201

Status201 401 403 404 500application/json

Schema ExampleCheckoutStateResponse

200 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 401 403 404 500application/json

Schema ExampleAccountCheckResponse

3 top-level fields

statusAccountCheckStatusRequired
Allowed values: "NEW_MEMBER", "EXISTING_MEMBER"
identityAccountCheckIdentityRequired
Allowed values: "EMAIL", "PHONE"
checkoutStateUUIDstringRequired

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

Schema ExampleAccountCheckResponse

201 · application/json

{
  "status": "NEW_MEMBER",
  "identity": "EMAIL",
  "checkoutStateUUID": "string"
}

Example · 5 linesShow full heightShow compact view

Responses 401

Status201 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

401 · application/json

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

Responses 403

Status201 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 404

Status201 401 403 404 500application/json

notFound

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status201 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

curl https://api.subrite.no/api/v1/checkout-state/account-check \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "phone": "<phone>",
  "data": {
    "packageId": 1,
    "isSaved": true,
    "optionalProducts": [],
    "userData": {},
    "billingAddress": {}
  }
}'

application/json

Schema ExampleAccountCheckResponse

Same fields as check account and create checkout state for existing member (201).

Schema ExampleAccountCheckResponse

200 · application/json

{
  "status": "NEW_MEMBER",
  "identity": "EMAIL",
  "checkoutStateUUID": "string"
}

Example · 5 linesShow full heightShow compact view

Responses 401

Status200 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}/account-check' \
  --request PATCH \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com",
  "phone": "<phone>",
  "data": {
    "packageId": 1,
    "isSaved": true,
    "optionalProducts": [],
    "userData": {},
    "billingAddress": {}
  }
}'

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 ExampleCheckoutStateResponse

Same fields as Get a checkout-state by uuid (200).

Schema ExampleCheckoutStateResponse

200 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

alreadyExists

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

400 · application/json

Responses 401

Status200 400 401 403 500application/json

unauthorized

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}/update-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
}'

CheckoutStateResponse

Schema ExampleCheckoutStateResponse

200 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 401

Status200 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (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 ExampleCheckoutStateResponse

Same fields as Get a checkout-state by uuid (200).

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 400

cannotInviteYourself, invitationNotSupported, invitationLimitReached,invitationAlreadyAccepted, invitationAlreadySent

This response has no body.

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

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

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 ExampleCheckoutStateResponse

Same fields as Get a checkout-state by uuid (200).

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

phoneAlreadyVerified

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}/create-additional-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": {}
}'

CheckoutStateResponse

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 401

Status201 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

CheckoutStateResponse

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 401

Status201 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

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 ExampleCheckoutStateResponse

Same fields as Get a checkout-state by uuid (200).

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 404 500application/json

phoneAlreadyVerified, cannotInviteYourself, invitationNotSupported, invitationLimitReached, invitationAlreadyAccepted, invitationAlreadySent

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}/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
}'

Responses

5 status codes

Responses 201

Status201 401 403 404 500application/json

Schema ExampleCheckoutStateResponse

Same fields as Get a checkout-state by uuid (200).

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 401

Status201 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

401 · application/json

Responses 403

Status201 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 404

Status201 401 403 404 500application/json

notFound

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status201 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}/complete-gift-receiver' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scheduledActivationDate": "2019-08-24T14:15:22Z"
}'

Responses

6 status codes

Responses 201

Status201 400 401 403 404 500application/json

Schema ExampleCheckoutStateResponse

Same fields as Get a checkout-state by uuid (200).

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 400

shouldNotBeEmpty

This response has no body.

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

Responses 403

Status201 400 401 403 404 500application/json

forbiddenResource

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 404

Status201 400 401 403 404 500application/json

notFound

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Responses 500

Status201 400 401 403 404 500application/json

internalServerError

SchemaErrorResponse

Same fields as Get a checkout-state by uuid (401).

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}/update-gift-receiver-addresses' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "physicalProducts": [
    {}
  ]
}'

application/json

Schema ExampleCheckoutStateResponse

Same fields as Get a checkout-state by uuid (200).

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 401

Status201 400 401 403 404 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Get a checkout-state by uuid (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Example requestcurl

curl

curl 'https://api.subrite.no/api/v1/checkout-state/{uuid}/save-delivery-addresses' \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "physicalProducts": [
    {}
  ]
}'

CheckoutStateResponse

Schema ExampleCheckoutStateResponse

201 · application/json

{
  "uuid": "string",
  "status": "created",
  "paymentData": {},
  "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": {}
  },
  "additionalMemberData": [
    {}
  ],
  "physicalProductData": {
    "memberAddressData": [],
    "productData": []
  },
  "giftReceiverData": [
    {}
  ],
  "giftReceiverDeliveryData": {
    "giftReceiverAddressData": [],
    "productData": []
  },
  "steps": [
    "created"
  ],
  "orderNumber": 0,
  "signInPhone": "<signInPhone>"
}

Example · 46 linesShow full heightShow compact view

Responses 401

Status201 401 403 404 500application/json

unauthorized

postCode

string

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

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

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

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

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

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

Get a checkout-state by uuid#

Parameters

Responses

Responses 200

Responses 401

Responses 403

Responses 404

Responses 410

Responses 500

check account and create checkout state for existing member#

Request body

check account and update checkout state for existing member#

Parameters

Request body

Responses

Responses 200

Update logged in member profile and checkout state#

Parameters

Request body

Populate group member and physical product data#

Parameters

Responses

Responses 200

Invite member to a product seat#

Parameters

Request body

Create additional member for a product seat#

Parameters

Request body

Complete additional members creation step#

Parameters

Responses

Responses 201

Assign default gift receiver data and store it in the checkout state#

Parameters

Responses

Responses 201

Create gift receiver for a product seat#

Parameters

Request body

Complete gift receiver step#

Parameters

Request body

Update gift receiver address of a physical product seat#

Parameters

Request body

Save delivery address of a physical product seat#

Parameters

Request body

Responses

Responses 201

Complete consent info step#

Parameters

Responses

Responses 201

Get a checkout-state by uuid#

Parameters

Responses

Responses 200

Responses 401

Responses 403

Responses 404

Responses 410

Responses 500

check account and create checkout state for existing member#

Request body

check account and update checkout state for existing member#

Parameters

Request body

Responses

Responses 200

Update logged in member profile and checkout state#

Parameters

Request body

Populate group member and physical product data#

Parameters

Responses

Responses 200

Invite member to a product seat#

Parameters