Member Subscriptions
Endpoints for Member Subscriptions
ReferenceView as Markdown
Endpoints for Member Subscriptions
GET/api/v1/members/{memberId}/subscriptions
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequired when parent is presentpackageIdnumberRequired when parent is presentnamestringRequired when parent is presentslugstringRequired when parent is presentstatusstringRequired when parent is present"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"nextRenewalstring (date-time)Required when parent is presenthasChangebooleanRequired when parent is presentchangePlanNamestringscheduledActivationDatestring (date-time)[
{
"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"
}
]unauthorized
This response has no body.
forbiddenResource
messageCodestringRequiredmessagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions' \
--header 'Authorization: Bearer <token>'GET/api/v1/members/{memberId}/subscriptions/list-with-products
Authentication: Bearer token (JWT)
memberIdstringRequiredstripeCardInfoStripeCardInfoRequired when parent is present5 fields[].stripeCardInfobrandstringRequired when parent is presentField path: [].stripeCardInfo.brandexpMonthnumberRequired when parent is presentField path: [].stripeCardInfo.expMonthexpYearnumberRequired when parent is presentField path: [].stripeCardInfo.expYearlast4stringRequired when parent is presentField path: [].stripeCardInfo.last4countrystringRequired when parent is presentField path: [].stripeCardInfo.countryvippsPaymentInfoVippsPaymentInfoRequired when parent is present2 fields[].vippsPaymentInfoagreementIdstringRequired when parent is presentField path: [].vippsPaymentInfo.agreementIdphonestringRequired when parent is presentField path: [].vippsPaymentInfo.phonenetsCardInfoNetsCardInfoRequired when parent is presentpaymentInfoPaymentRequired when parent is present28 fields[].paymentInfopackageIdnumberRequired when parent is presentField path: [].paymentInfo.packageIdaccountingDatestring (date-time)Required when parent is presentField path: [].paymentInfo.accountingDateregistrationDatestring (date-time)Required when parent is presentField path: [].paymentInfo.registrationDatepaymentProviderstringRequired when parent is presentField path: [].paymentInfo.paymentProvider"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"paymentMethodstringRequired when parent is presentField path: [].paymentInfo.paymentMethod"card", "vipps", "manual_registration", "efaktura", "ehf", "avtalegiro"amountnumberRequired when parent is presentField path: [].paymentInfo.amountcurrencystringRequired when parent is presentField path: [].paymentInfo.currencystatusstringRequired when parent is presentField path: [].paymentInfo.status"pending", "succeeded", "failed"notestringRequired when parent is presentField path: [].paymentInfo.noteisAdminActionbooleanRequired when parent is presentField path: [].paymentInfo.isAdminActionmemberIdstringRequired when parent is presentField path: [].paymentInfo.memberIdstripePaymentStripePaymentRequired when parent is presentField path: [].paymentInfo.stripePaymentNested fields omitted: field limit.vippsPaymentVippsPaymentRequired when parent is presentField path: [].paymentInfo.vippsPaymentNested fields omitted: field limit.netsPaymentNetsPaymentRequired when parent is presentField path: [].paymentInfo.netsPaymentNested fields omitted: field limit.eInvoicePaymentEInvoicePaymentRequired when parent is presentField path: [].paymentInfo.eInvoicePaymentNested fields omitted: field limit.swedbankpayPaymentSwedbankpayPaymentRequired when parent is presentField path: [].paymentInfo.swedbankpayPaymentNested fields omitted: field limit.packagePackageRequired when parent is presentField path: [].paymentInfo.packageNested fields omitted: field limit.orderOrderRequired when parent is presentField path: [].paymentInfo.orderNested fields omitted: field limit.checkoutStateCheckoutStateRequired when parent is presentField path: [].paymentInfo.checkoutStateNested fields omitted: field limit.invoiceIdnumberRequired when parent is presentField path: [].paymentInfo.invoiceIdinvoiceInvoiceRequired when parent is presentField path: [].paymentInfo.invoiceNested fields omitted: field limit.memberMemberRequired when parent is presentField path: [].paymentInfo.memberNested fields omitted: field limit.updatedBynumberRequired when parent is presentField path: [].paymentInfo.updatedByidnumberRequired when parent is presentField path: [].paymentInfo.idcreatedAtstring (date-time)Required when parent is presentField path: [].paymentInfo.createdAtupdatedAtstring (date-time)Required when parent is presentField path: [].paymentInfo.updatedAtdeletedAtstring (date-time)Required when parent is presentField path: [].paymentInfo.deletedAtmetaDataobjectRequired when parent is presentField path: [].paymentInfo.metaDatapaymentProviderstringRequired when parent is present"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"idnumberRequired when parent is presentstatusstringRequired when parent is present"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"planNamestringRequired when parent is presentpackNamestringRequired when parent is presentpackageIdnumberRequired when parent is presentslugstringRequired when parent is presentrecurringPricenumberRequired when parent is presentcurrentPricenumberRequired when parent is presentintroPeriodInfoBillingPeriodInfoRequired when parent is present2 fields[].introPeriodInfobillingPeriodstringRequired when parent is presentField path: [].introPeriodInfo.billingPeriodcustomBillingPeriodBillingPeriodDetailsRequired when parent is presentField path: [].introPeriodInfo.customBillingPeriod2 fields[].introPeriodInfo.customBillingPeriodbillingPeriodFrequencynumberRequired when parent is presentField path: [].introPeriodInfo.customBillingPeriod.billingPeriodFrequencybillingPeriodUnitstringRequired when parent is presentField path: [].introPeriodInfo.customBillingPeriod.billingPeriodUnitrecurringPeriodInfoBillingPeriodInfoRequired when parent is present2 fields[].recurringPeriodInfobillingPeriodstringRequired when parent is presentField path: [].recurringPeriodInfo.billingPeriodcustomBillingPeriodBillingPeriodDetailsRequired when parent is presentField path: [].recurringPeriodInfo.customBillingPeriod2 fields[].recurringPeriodInfo.customBillingPeriodbillingPeriodFrequencynumberRequired when parent is presentField path: [].recurringPeriodInfo.customBillingPeriod.billingPeriodFrequencybillingPeriodUnitstringRequired when parent is presentField path: [].recurringPeriodInfo.customBillingPeriod.billingPeriodUnitproductsarray of MemberSubscribedProductRequired when parent is presentNested fields omitted: field limit.billingPeriodstringRequired when parent is present"monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"billingPeriodFrequencynumberRequired when parent is presentbillingPeriodUnitstringRequired when parent is present"day", "week", "month", "year"currentPeriodStartstring (date-time)Required when parent is presentcurrentPeriodEndstring (date-time)Required when parent is presentnextRenewalstring (date-time)Required when parent is presentexpiresAtstring (date-time)Required when parent is presentcancelledAtstring (date-time)Required when parent is presentautoRenewbooleanRequired when parent is presentactiveSincestring (date-time)Required when parent is presentisOwnerbooleanRequired when parent is presentgroupOwnerMemberIdstringRequired when parent is presentgroupOwnerMemberNumbernumberRequired when parent is presentgroupOwnerMemberNamestringRequired when parent is presentgroupInfoGroupSubscriptionResponseRequired when parent is presentisPayablebooleanRequired when parent is presentchangeMemberPackageChangeRequired when parent is presentsubscriptionPlanIdnumberRequired when parent is presentsubscriptionPlanNamestringRequired when parent is presentscheduledActivationDatestring (date-time)Required when parent is present[
{
"stripeCardInfo": {},
"vippsPaymentInfo": {},
"netsCardInfo": {},
"paymentInfo": {
"metaData": {}
},
"paymentProvider": "stripe",
"id": 0,
"status": "active",
"planName": "string",
"packName": "string",
"packageId": 0,
"slug": "string",
"recurringPrice": 0,
"currentPrice": 0,
"introPeriodInfo": {},
"recurringPeriodInfo": {},
"products": [],
"billingPeriod": "monthly",
"billingPeriodFrequency": 0,
"billingPeriodUnit": "day",
"currentPeriodStart": "2019-08-24T14:15:22Z",
"currentPeriodEnd": "2019-08-24T14:15:22Z",
"nextRenewal": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"autoRenew": true,
"activeSince": "2019-08-24T14:15:22Z",
"isOwner": true,
"groupOwnerMemberId": "string",
"groupOwnerMemberNumber": 0,
"groupOwnerMemberName": "<groupOwnerMemberName>",
"groupInfo": {
"seats": []
},
"isPayable": true,
"change": {
"metaData": {}
},
"subscriptionPlanId": 0,
"subscriptionPlanName": "string",
"scheduledActivationDate": "2019-08-24T14:15:22Z"
}
]unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/list-with-products' \
--header 'Authorization: Bearer <token>'GET/api/v1/members/{memberId}/subscriptions/has-blocking-subscription
Authentication: Bearer token (JWT)
memberIdstringRequiredhasBlockingSubscriptionbooleanRequired{
"hasBlockingSubscription": true
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/has-blocking-subscription' \
--header 'Authorization: Bearer <token>'GET/api/v1/members/{memberId}/subscriptions/missing-info
Authentication: Bearer token (JWT)
memberIdstringRequiredmissingInfoTypeMISSING_INFORequired when parent is present"member_details", "invited_member_details", "member_not_invited", "gift_receiver_not_added", "activation_date", "available_subscriptions_to_join", "active_subscriptions"alertIndexstringRequired when parent is presentmissingFieldsarray of stringRequired when parent is presentinvitedMemberInfoInvitedMemberInfoRequired when parent is present5 fields[].invitedMemberInfosubscriptionIdnumberRequired when parent is presentField path: [].invitedMemberInfo.subscriptionIdseatIdnumberRequired when parent is presentField path: [].invitedMemberInfo.seatIdmemberPackageProductIdnumberRequired when parent is presentField path: [].invitedMemberInfo.memberPackageProductIdproductNamestringRequired when parent is presentField path: [].invitedMemberInfo.productNameinvitedMemberEmailstringRequired when parent is presentField path: [].invitedMemberInfo.invitedMemberEmailmemberNotInvitedInfoMemberNotInvitedInfoRequired when parent is present3 fields[].memberNotInvitedInfosubscriptionIdnumberRequired when parent is presentField path: [].memberNotInvitedInfo.subscriptionIdpackageNamestringRequired when parent is presentField path: [].memberNotInvitedInfo.packageNamesubscriptionProductInfoarray of SubscriptionProductInfoRequired when parent is presentField path: [].memberNotInvitedInfo.subscriptionProductInfo2 fields[].memberNotInvitedInfo.subscriptionProductInfomemberPackageProductIdnumberRequired when parent is presentField path: [].memberNotInvitedInfo.subscriptionProductInfo[].memberPackageProductIdproductNamestringRequired when parent is presentField path: [].memberNotInvitedInfo.subscriptionProductInfo[].productNamegiftReceiverNotAddedInfoGiftReceiverNotAddedInfoRequired when parent is present3 fields[].giftReceiverNotAddedInfosubscriptionIdnumberRequired when parent is presentField path: [].giftReceiverNotAddedInfo.subscriptionIdplanNamestringRequired when parent is presentField path: [].giftReceiverNotAddedInfo.planNamesubscriptionProductInfoarray of SubscriptionProductInfoRequired when parent is presentField path: [].giftReceiverNotAddedInfo.subscriptionProductInfo2 fields[].giftReceiverNotAddedInfo.subscriptionProductInfomemberPackageProductIdnumberRequired when parent is presentField path: [].giftReceiverNotAddedInfo.subscriptionProductInfo[].memberPackageProductIdproductNamestringRequired when parent is presentField path: [].giftReceiverNotAddedInfo.subscriptionProductInfo[].productNameactivationDateMissingInfoActivationDateMissingInfoRequired when parent is present2 fields[].activationDateMissingInfosubscriptionIdnumberRequired when parent is presentField path: [].activationDateMissingInfo.subscriptionIdplanNamestringRequired when parent is presentField path: [].activationDateMissingInfo.planNameavailableSubscriptionsToJoinarray of MemberPackageProductRequired when parent is present20 fields[].availableSubscriptionsToJoinmemberPackageIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageIdproductIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].productIdpricenumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].pricerecurringPricenumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].recurringPricequantitynumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].quantityhasAccessbooleanRequired when parent is presentField path: [].availableSubscriptionsToJoin[].hasAccessshippingCountrystringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].shippingCountryshippingProviderstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].shippingProvider"Helthjem", "Bring - Posten", "Distribution Innovation"allowDistributorToUpdateDeliveryAddressbooleanRequired when parent is presentField path: [].availableSubscriptionsToJoin[].allowDistributorToUpdateDeliveryAddressmemberPackageProductEmailDomainsarray of MemberPackageProductEmailDomainRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains9 fields[].availableSubscriptionsToJoin[].memberPackageProductEmailDomainsmemberPackageProductIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].memberPackageProductIdemailDomainstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].emailDomainupdatedBynumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].updatedBymemberPackageProductMemberPackageProductRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].memberPackageProductRecursive schema; nested fields are not repeated.idnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].idcreatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].deletedAtmetaDataobjectRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductEmailDomains[].metaDatamemberPackageProductIpsarray of MemberPackageProductIpRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps10 fields[].availableSubscriptionsToJoin[].memberPackageProductIpsmemberPackageProductIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].memberPackageProductIdipRangestringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].ipRangelabelstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].labelupdatedBynumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].updatedBymemberPackageProductMemberPackageProductRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].memberPackageProductRecursive schema; nested fields are not repeated.idnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].idcreatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].deletedAtmetaDataobjectRequired when parent is presentField path: [].availableSubscriptionsToJoin[].memberPackageProductIps[].metaDatamemberPackageMemberPackageRequired 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[].seatsmemberPackageProductIdnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].memberPackageProductIdmemberIdstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].memberIdemailstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].emailacceptedbooleanRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].acceptedacceptedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].acceptedAtexpiresAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].expiresAtuuidstringRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].uuidmemberPackageProductMemberPackageProductRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].memberPackageProductRecursive schema; nested fields are not repeated.memberMemberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].memberNested fields omitted: depth limit.idnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].idcreatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].deletedAtmetaDataobjectRequired when parent is presentField path: [].availableSubscriptionsToJoin[].seats[].metaDatarecipientsarray of MemberPackageProductRecipientRequired when parent is presentField path: [].availableSubscriptionsToJoin[].recipientsNested fields omitted: field limit.idnumberRequired when parent is presentField path: [].availableSubscriptionsToJoin[].idcreatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: [].availableSubscriptionsToJoin[].deletedAtmetaDataobjectRequired when parent is presentField path: [].availableSubscriptionsToJoin[].metaDatabuyNewSubscriptionPackageSlugstringRequired when parent is present[
{
"missingInfoType": "member_details",
"alertIndex": "string",
"missingFields": [],
"invitedMemberInfo": {},
"memberNotInvitedInfo": {
"subscriptionProductInfo": []
},
"giftReceiverNotAddedInfo": {
"subscriptionProductInfo": []
},
"activationDateMissingInfo": {},
"availableSubscriptionsToJoin": [],
"buyNewSubscriptionPackageSlug": "string"
}
]unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/missing-info' \
--header 'Authorization: Bearer <token>'GET/api/v1/members/{memberId}/subscriptions/{id}
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredidnumberRequiredpackageIdnumberRequirednamestringRequiredslugstringRequiredsubscriptionPlanIdnumberRequiredsubscriptionPlanNamestringRequiredrecurringPricenumberRequiredautoRenewbooleanRequiredpaymentInfoPaymentInfoRequired7 fieldspaymentInfostripeCardInfoStripeCardInfoRequiredField path: paymentInfo.stripeCardInfo5 fieldspaymentInfo.stripeCardInfobrandstringRequiredField path: paymentInfo.stripeCardInfo.brandexpMonthnumberRequiredField path: paymentInfo.stripeCardInfo.expMonthexpYearnumberRequiredField path: paymentInfo.stripeCardInfo.expYearlast4stringRequiredField path: paymentInfo.stripeCardInfo.last4countrystringRequiredField path: paymentInfo.stripeCardInfo.countryisLinkbooleanRequiredField path: paymentInfo.isLinknetsCardInfoNetsCardInfoRequiredField path: paymentInfo.netsCardInfoswedbankpayCardInfoSwedbankpayCardInfoRequiredField path: paymentInfo.swedbankpayCardInfoNested fields omitted: field limit.vippsPaymentInfoWithDueChargeVippsPaymentInfoWithDueChargeRequiredField path: paymentInfo.vippsPaymentInfoWithDueChargeNested fields omitted: field limit.eInvoicePaymentInfoEInvoicePaymentInfoRequiredField path: paymentInfo.eInvoicePaymentInfoNested fields omitted: field limit.externalPaymentInfoExternalPaymentInfoRequiredField path: paymentInfo.externalPaymentInfo2 fieldspaymentInfo.externalPaymentInfoisPaidbooleanRequiredField path: paymentInfo.externalPaymentInfo.isPaidpaidTillstring (date-time)RequiredField path: paymentInfo.externalPaymentInfo.paidTillpaymentProviderstring"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"isOwnerbooleanRequiredcanRemovePaymentMethodbooleanRequiredhasStoredPaymentMethodbooleanRequiredisGroupSubscriptionbooleanRequiredstatusMEMBER_PACKAGE_STATUSRequired"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"groupOwnerNamestringRequiredproductsarray of ProductPackageRequired15 fieldsproductscirculationTypeCIRCULATION_TYPEField path: products[].circulationType"subscription", "single_copy"idnumberRequired when parent is presentField path: products[].idnamestringRequired when parent is presentField path: products[].nameproductIdnumberRequired when parent is presentField path: products[].productIdproductCategorystringRequired when parent is presentField path: products[].productCategory"digital_subscription", "physical_subscription", "physical", "event_ticket", "PHYSICAL_PRODUCT"pricenumberRequired when parent is presentField path: products[].pricerecurringPricenumberRequired when parent is presentField path: products[].recurringPricequantitynumberRequired when parent is presentField path: products[].quantityhasAccessbooleanRequired when parent is presentField path: products[].hasAccessisOptionalbooleanRequired when parent is presentField path: products[].isOptionalshippingCountrystringRequired when parent is presentField path: products[].shippingCountryshippingChargesarray of ShippingChargeRequired when parent is presentField path: products[].shippingChargesNested fields omitted: field limit.shippingCountriesarray of stringRequired when parent is presentField path: products[].shippingCountriesshippingPricenumberRequired when parent is presentField path: products[].shippingPricegroupInfoGroupSubscriptionResponseRequired when parent is presentField path: products[].groupInfoNested fields omitted: field limit.currentPeriodBillingInfoBillingPeriodInfoRequired2 fieldscurrentPeriodBillingInfobillingPeriodstringRequiredField path: currentPeriodBillingInfo.billingPeriodcustomBillingPeriodBillingPeriodDetailsRequiredField path: currentPeriodBillingInfo.customBillingPeriodNested fields omitted: field limit.nextPeriodBillingInfoBillingPeriodInfoRequired2 fieldsnextPeriodBillingInfobillingPeriodstringRequiredField path: nextPeriodBillingInfo.billingPeriodcustomBillingPeriodBillingPeriodDetailsRequiredField path: nextPeriodBillingInfo.customBillingPeriodNested fields omitted: field limit.currentPeriodPricenumberRequirednextPeriodPricenumberRequirednextRenewalstring (date-time)RequiredexpiresAtstring (date-time)RequiredchangeBlockReasonSUBSCRIPTION_CHANGE_BLOCK_REASON"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"allowSameSubscriptionChangebooleanRequiredallowDifferentSubscriptionSwitchbooleanRequiredallowAdminSameSubscriptionChangebooleanRequiredallowAdminDifferentSubscriptionSwitchbooleanRequiredenableGiftSubscriptionbooleanRequiredallowFutureStartDatebooleanRequiredallowAutoRenewChangebooleanRequiredchangeDataChangeSubscriptionDetailsprimaryAddressProfileAddressRequiredNested fields omitted: field limit.invoiceAddressProfileAddressRequiredgroupOwnerMemberNamestringRequiredgroupOwnerMemberIdstringRequiredgroupOwnerMemberNumbernumberRequiredgroupOwnerPhoneNumberstringRequiredactiveSincestring (date-time)RequiredcurrentPeriodStartstring (date-time)RequiredcurrentPeriodEndstring (date-time)RequiredscheduledActivationDatestring (date-time)RequiredlastActiveAtstring (date-time)hasOptionalProductsInPlanbooleanRequiredinviteAcceptedProductsarray of MemberPackageProductSeatRequiredNested fields omitted: field limit.recipientAttachedProductsarray of MemberPackageProductRequiredNested fields omitted: field limit.isLinkboolean{
"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
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/{id}' \
--header 'Authorization: Bearer <token>'PATCH/api/v1/members/{memberId}/subscriptions/{id}
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonautoRenewbooleanOptionalnextRenewalstring (date-time)OptionalscheduledActivationDatestring (date-time)Optional{
"autoRenew": true,
"nextRenewal": "2019-08-24T14:15:22Z",
"scheduledActivationDate": "2019-08-24T14:15:22Z"
}This response has no body.
alreadyOn
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/{id}' \
--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"
}'PATCH/api/v1/members/{memberId}/subscriptions/{id}/stop
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredThis response has no body.
alreadyStopped, canNotStopSubscriptionAsVippsChargeMightOnProgress
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/{id}/stop' \
--request PATCH \
--header 'Authorization: Bearer <token>'PATCH/api/v1/members/{memberId}/subscriptions/{id}/change
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsonplanIdnumberOptionalisImmediatebooleanRequiredproductsarray of OptionalProductWithQuantityOptional2 required when the containing object is present4 fieldsproductsproductIdnumberRequired when parent is presentField path: products[].productIdminimum: 1quantitynumberRequired when parent is presentField path: products[].quantityminimum: 1shippingCountrystringOptionalField path: products[].shippingCountrymaxLength: 64manualPricenumberOptionalField path: products[].manualPriceseatTransferMaparray of SeatTransferMappingDtoOptional2 required when the containing object is present2 fieldsseatTransferMapfromMemberPackageProductIdnumberRequired when parent is presentField path: seatTransferMap[].fromMemberPackageProductIdtoNewPlanProductIdnumberRequired when parent is presentField path: seatTransferMap[].toNewPlanProductId{
"planId": 0,
"isImmediate": true
}subscriptionChangeIdnumberRequiredorderIdnumber{
"subscriptionChangeId": 0,
"orderId": 0
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/{id}/change' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"planId": 0,
"isImmediate": true,
"products": [
{}
],
"seatTransferMap": [
{}
]
}'GET/api/v1/members/{memberId}/subscriptions/subscriptions/{id}/change/{changeId}
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredchangeIdnumberRequiredidnumberRequiredcurrentPlanNamestringRequirednewPlanNamestringRequiredcurrentProductsarray of ProductPackageRequired15 fieldscurrentProductscirculationTypeCIRCULATION_TYPEField path: currentProducts[].circulationType"subscription", "single_copy"idnumberRequired when parent is presentField path: currentProducts[].idnamestringRequired when parent is presentField path: currentProducts[].nameproductIdnumberRequired when parent is presentField path: currentProducts[].productIdproductCategorystringRequired when parent is presentField path: currentProducts[].productCategory"digital_subscription", "physical_subscription", "physical", "event_ticket", "PHYSICAL_PRODUCT"pricenumberRequired when parent is presentField path: currentProducts[].pricerecurringPricenumberRequired when parent is presentField path: currentProducts[].recurringPricequantitynumberRequired when parent is presentField path: currentProducts[].quantityhasAccessbooleanRequired when parent is presentField path: currentProducts[].hasAccessisOptionalbooleanRequired when parent is presentField path: currentProducts[].isOptionalshippingCountrystringRequired when parent is presentField path: currentProducts[].shippingCountryshippingChargesarray of ShippingChargeRequired when parent is presentField path: currentProducts[].shippingCharges2 fieldscurrentProducts[].shippingChargescountrystringRequired when parent is presentField path: currentProducts[].shippingCharges[].countrychargenumberRequired when parent is presentField path: currentProducts[].shippingCharges[].chargeshippingCountriesarray of stringRequired when parent is presentField path: currentProducts[].shippingCountriesshippingPricenumberRequired when parent is presentField path: currentProducts[].shippingPricegroupInfoGroupSubscriptionResponseRequired when parent is presentField path: currentProducts[].groupInfo11 fieldscurrentProducts[].groupInfoownerHasAccessbooleanRequired when parent is presentField path: currentProducts[].groupInfo.ownerHasAccessfalseseatsAllowednumberRequired when parent is presentField path: currentProducts[].groupInfo.seatsAllowed0seatsActivenumberRequired when parent is presentField path: currentProducts[].groupInfo.seatsActive0seatsRemainingnumberRequired when parent is presentField path: currentProducts[].groupInfo.seatsRemaining0groupMemberCountnumberRequired when parent is presentField path: currentProducts[].groupInfo.groupMemberCount0Group members holding a live seat (accepted or open invitation). Excludes the owner's own access and expired invitations.maxQuantityPerOrdernumberRequired when parent is presentField path: currentProducts[].groupInfo.maxQuantityPerOrderassignSeatToOwnerbooleanRequired when parent is presentField path: currentProducts[].groupInfo.assignSeatToOwnergroupOwnerMemberNamestringRequired when parent is presentField path: currentProducts[].groupInfo.groupOwnerMemberNamegroupOwnerMemberIdstringRequired when parent is presentField path: currentProducts[].groupInfo.groupOwnerMemberIdgroupOwnerMemberNumbernumberRequired when parent is presentField path: currentProducts[].groupInfo.groupOwnerMemberNumberseatsarray of SeatDataRequired when parent is presentField path: currentProducts[].groupInfo.seats[]DeprecatednewProductsarray of ProductPackageRequired15 fieldsnewProductscirculationTypeCIRCULATION_TYPEField path: newProducts[].circulationType"subscription", "single_copy"idnumberRequired when parent is presentField path: newProducts[].idnamestringRequired when parent is presentField path: newProducts[].nameproductIdnumberRequired when parent is presentField path: newProducts[].productIdproductCategorystringRequired when parent is presentField path: newProducts[].productCategory"digital_subscription", "physical_subscription", "physical", "event_ticket", "PHYSICAL_PRODUCT"pricenumberRequired when parent is presentField path: newProducts[].pricerecurringPricenumberRequired when parent is presentField path: newProducts[].recurringPricequantitynumberRequired when parent is presentField path: newProducts[].quantityhasAccessbooleanRequired when parent is presentField path: newProducts[].hasAccessisOptionalbooleanRequired when parent is presentField path: newProducts[].isOptionalshippingCountrystringRequired when parent is presentField path: newProducts[].shippingCountryshippingChargesarray of ShippingChargeRequired when parent is presentField path: newProducts[].shippingCharges2 fieldsnewProducts[].shippingChargescountrystringRequired when parent is presentField path: newProducts[].shippingCharges[].countrychargenumberRequired when parent is presentField path: newProducts[].shippingCharges[].chargeshippingCountriesarray of stringRequired when parent is presentField path: newProducts[].shippingCountriesshippingPricenumberRequired when parent is presentField path: newProducts[].shippingPricegroupInfoGroupSubscriptionResponseRequired when parent is presentField path: newProducts[].groupInfoNested fields omitted: field limit.currentPaymentProviderInfoPaymentInfoRequired7 fieldscurrentPaymentProviderInfostripeCardInfoStripeCardInfoRequiredField path: currentPaymentProviderInfo.stripeCardInfo5 fieldscurrentPaymentProviderInfo.stripeCardInfobrandstringRequiredField path: currentPaymentProviderInfo.stripeCardInfo.brandexpMonthnumberRequiredField path: currentPaymentProviderInfo.stripeCardInfo.expMonthexpYearnumberRequiredField path: currentPaymentProviderInfo.stripeCardInfo.expYearlast4stringRequiredField path: currentPaymentProviderInfo.stripeCardInfo.last4countrystringRequiredField path: currentPaymentProviderInfo.stripeCardInfo.countryisLinkbooleanRequiredField path: currentPaymentProviderInfo.isLinknetsCardInfoNetsCardInfoRequiredField path: currentPaymentProviderInfo.netsCardInfoswedbankpayCardInfoSwedbankpayCardInfoRequiredField path: currentPaymentProviderInfo.swedbankpayCardInfoNested fields omitted: field limit.vippsPaymentInfoWithDueChargeVippsPaymentInfoWithDueChargeRequiredField path: currentPaymentProviderInfo.vippsPaymentInfoWithDueChargeNested fields omitted: field limit.eInvoicePaymentInfoEInvoicePaymentInfoRequiredField path: currentPaymentProviderInfo.eInvoicePaymentInfoNested fields omitted: field limit.externalPaymentInfoExternalPaymentInfoRequiredField path: currentPaymentProviderInfo.externalPaymentInfo2 fieldscurrentPaymentProviderInfo.externalPaymentInfoisPaidbooleanRequiredField path: currentPaymentProviderInfo.externalPaymentInfo.isPaidpaidTillstring (date-time)RequiredField path: currentPaymentProviderInfo.externalPaymentInfo.paidTillcurrentBillingPeriodBillingPeriodInfoRequired2 fieldscurrentBillingPeriodbillingPeriodstringRequiredField path: currentBillingPeriod.billingPeriodcustomBillingPeriodBillingPeriodDetailsRequiredField path: currentBillingPeriod.customBillingPeriodNested fields omitted: field limit.newBillingPeriodBillingPeriodInfoRequired2 fieldsnewBillingPeriodbillingPeriodstringRequiredField path: newBillingPeriod.billingPeriodcustomBillingPeriodBillingPeriodDetailsRequiredField path: newBillingPeriod.customBillingPeriodNested fields omitted: field limit.currentPeriodStartstring (date-time)RequirednextRenewalstring (date-time)RequirednewPeriodStartstring (date-time)RequiredchangeInPricenumberRequiredcurrentRecurringPricenumberRequirednextRenewalPricenumberRequiredautoRenewbooleanRequirednewPackageAutoRenewbooleanRequiredorderIdnumberRequired{
"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
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/subscriptions/{id}/change/{changeId}' \
--header 'Authorization: Bearer <token>'PATCH/api/v1/members/{memberId}/subscriptions/subscriptions/{subscriptionPlanId}/change/{changeId}/cancel
Authentication: Bearer token (JWT)
memberIdstringRequiredsubscriptionPlanIdnumberRequiredchangeIdnumberRequiredThis response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/subscriptions/{subscriptionPlanId}/change/{changeId}/cancel' \
--request PATCH \
--header 'Authorization: Bearer <token>'PATCH/api/v1/members/{memberId}/subscriptions/subscriptions/{subscriptionPlanId}/change/{changeId}/confirm
Authentication: Bearer token (JWT)
memberIdstringRequiredsubscriptionPlanIdnumberRequiredchangeIdnumberRequiredapplication/jsonisImmediatebooleanRequired{
"isImmediate": true
}This response has no body.
invalidStatus | seatTransferDuplicateSource | seatTransferSourceMissing | seatTransferTargetMissing
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
notFound | subscriptionPlanNotFound | memberPackageNotFound
Same fields as Get all subscriptions of a member (403).
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/subscriptions/{subscriptionPlanId}/change/{changeId}/confirm' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"isImmediate": true
}'PATCH/api/v1/members/{memberId}/subscriptions/{id}/activation-date
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonSame fields as Update particular subscription of a member (Request body).
{
"autoRenew": true,
"nextRenewal": "2019-08-24T14:15:22Z",
"scheduledActivationDate": "2019-08-24T14:15:22Z"
}This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/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"
}'GET/api/v1/members/{memberId}/subscriptions/product/{id}
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredidnumberRequiredproductIdnumberRequirednamestringRequiredproductCategoryProductCategory"digital_subscription", "physical_subscription", "physical", "event_ticket", "PHYSICAL_PRODUCT"circulationTypeCIRCULATION_TYPE"subscription", "single_copy"quantitynumberRequiredpricenumberRequiredrecurringPricenumberRequiredisOptionalbooleanRequiredshippingCountrystringRequiredshippingProviderSHIPPING_PROVIDERRequired"Helthjem", "Bring - Posten", "Distribution Innovation"allowDistributorToUpdateDeliveryAddressbooleanRequireddeliveryAddressesarray of DeliveryAddress14 fieldsdeliveryAddressesidnumberRequired when parent is presentField path: deliveryAddresses[].idroutestringField path: deliveryAddresses[].routeline1stringRequired when parent is presentField path: deliveryAddresses[].line1line2stringRequired when parent is presentField path: deliveryAddresses[].line2citystringRequired when parent is presentField path: deliveryAddresses[].citypostCodestringRequired when parent is presentField path: deliveryAddresses[].postCodecountrystringRequired when parent is presentField path: deliveryAddresses[].countrynamestringRequired when parent is presentField path: deliveryAddresses[].nameemailstringRequired when parent is presentField path: deliveryAddresses[].emailcompanyNamestringRequired when parent is presentField path: deliveryAddresses[].companyNameorganizationNostringRequired when parent is presentField path: deliveryAddresses[].organizationNoinvoiceReferencestringField path: deliveryAddresses[].invoiceReferenceisSyncedbooleanField path: deliveryAddresses[].isSyncedlastSyncedAtstring (date-time)Field path: deliveryAddresses[].lastSyncedAtgroupInfoGroupSubscriptionResponse11 fieldsgroupInfoownerHasAccessbooleanRequired when parent is presentField path: groupInfo.ownerHasAccessfalseseatsAllowednumberRequired when parent is presentField path: groupInfo.seatsAllowed0seatsActivenumberRequired when parent is presentField path: groupInfo.seatsActive0seatsRemainingnumberRequired when parent is presentField path: groupInfo.seatsRemaining0groupMemberCountnumberRequired when parent is presentField path: groupInfo.groupMemberCount0Group members holding a live seat (accepted or open invitation). Excludes the owner's own access and expired invitations.maxQuantityPerOrdernumberRequired when parent is presentField path: groupInfo.maxQuantityPerOrderassignSeatToOwnerbooleanRequired when parent is presentField path: groupInfo.assignSeatToOwnergroupOwnerMemberNamestringRequired when parent is presentField path: groupInfo.groupOwnerMemberNamegroupOwnerMemberIdstringRequired when parent is presentField path: groupInfo.groupOwnerMemberIdgroupOwnerMemberNumbernumberRequired when parent is presentField path: groupInfo.groupOwnerMemberNumberseatsarray of SeatDataRequired when parent is presentDefault: []DeprecatedField path: groupInfo.seats7 fieldsgroupInfo.seatsidnumberRequired when parent is presentField path: groupInfo.seats[].idnamestringRequired when parent is presentField path: groupInfo.seats[].nameemailstringRequired when parent is presentField path: groupInfo.seats[].emailstatusstringRequired when parent is presentField path: groupInfo.seats[].status"pending", "accepted", "expired", "awaiting_activation"memberIdstringRequired when parent is presentField path: groupInfo.seats[].memberIdmemberDataMemberPersonalInfoRequired when parent is presentField path: groupInfo.seats[].memberDataNested fields omitted: depth limit.expiresAtstringRequired when parent is presentField path: groupInfo.seats[].expiresAtgiftReceiverInfoGiftReceiverResponse8 fieldsgiftReceiverInfoseatsAllowednumberRequired when parent is presentField path: giftReceiverInfo.seatsAllowed0seatsActivenumberRequired when parent is presentField path: giftReceiverInfo.seatsActive0seatsRemainingnumberRequired when parent is presentField path: giftReceiverInfo.seatsRemaining0maxQuantityPerOrdernumberRequired when parent is presentField path: giftReceiverInfo.maxQuantityPerOrdergroupOwnerMemberNamestringRequired when parent is presentField path: giftReceiverInfo.groupOwnerMemberNamegroupOwnerMemberIdstringRequired when parent is presentField path: giftReceiverInfo.groupOwnerMemberIdgroupOwnerMemberNumbernumberRequired when parent is presentField path: giftReceiverInfo.groupOwnerMemberNumberseatsarray of SeatDataRequired when parent is presentField path: giftReceiverInfo.seats[]primaryAddressProfileAddress12 fieldsprimaryAddressline1stringRequired when parent is presentField path: primaryAddress.line1line2stringRequired when parent is presentField path: primaryAddress.line2citystringRequired when parent is presentField path: primaryAddress.citypostCodestringRequired when parent is presentField path: primaryAddress.postCodecountrystringRequired when parent is presentField path: primaryAddress.countrynamestringRequired when parent is presentField path: primaryAddress.nameemailstringRequired when parent is presentField path: primaryAddress.emailcompanyNamestringRequired when parent is presentField path: primaryAddress.companyNameorganizationNostringRequired when parent is presentField path: primaryAddress.organizationNoinvoiceReferencestringField path: primaryAddress.invoiceReferenceisSyncedbooleanField path: primaryAddress.isSyncedlastSyncedAtstring (date-time)Field path: primaryAddress.lastSyncedAtemailDomainsarray of stringsupportsIpAccessbooleanRequiredsupportsIpRangeConfigurationbooleanRequiredipRangesarray of IpRangeDtoRequired2 fieldsipRangesipRangestringRequired when parent is presentField path: ipRanges[].ipRangelabelstringField path: ipRanges[].label{
"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": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}' \
--header 'Authorization: Bearer <token>'GET/api/v1/members/{memberId}/subscriptions/product/{id}/seats
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredpagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptional"createdAt"Allowed values: "createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"searchstringOptionalstatusstringOptional"active", "invite_sent", "expired"itemsarray of SeatDataRequired7 fieldsitemsidnumberRequired when parent is presentField path: items[].idnamestringRequired when parent is presentField path: items[].nameemailstringRequired when parent is presentField path: items[].emailstatusstringRequired when parent is presentField path: items[].status"pending", "accepted", "expired", "awaiting_activation"memberIdstringRequired when parent is presentField path: items[].memberIdmemberDataMemberPersonalInfoRequired when parent is presentField path: items[].memberData20 fieldsitems[].memberDataidstringRequired when parent is presentField path: items[].memberData.idfullNamestringRequired when parent is presentField path: items[].memberData.fullNamenickNamestringRequired when parent is presentField path: items[].memberData.nickNamecreatedAtstring (date-time)Required when parent is presentField path: items[].memberData.createdAtavatarstringRequired when parent is presentField path: items[].memberData.avatarcountryCodestringField path: items[].memberData.countryCodebirthDatestring (date-time)Required when parent is presentField path: items[].memberData.birthDatedeleteAfterExpirationbooleanRequired when parent is presentField path: items[].memberData.deleteAfterExpirationisCompanybooleanRequired when parent is presentField path: items[].memberData.isCompanycompanyNamestringRequired when parent is presentField path: items[].memberData.companyNameorganizationNostringRequired when parent is presentField path: items[].memberData.organizationNocustomPropertyValuesobjectRequired when parent is presentField path: items[].memberData.customPropertyValuesemailVerifiedstringField path: items[].memberData.emailVerifiedphoneVerifiedbooleanRequired when parent is presentField path: items[].memberData.phoneVerifiedmemberNumbernumberRequired when parent is presentField path: items[].memberData.memberNumberuserIdnumberRequired when parent is presentField path: items[].memberData.userIdemailStatusSENDGRID_MAIL_EVENTSField path: items[].memberData.emailStatus"scheduled", "processed", "dropped", "deferred", "bounce", "hard_bounce", "soft_bounce", "spamreport", "delivered", "unsubscribe", "group_unsubscribe", "group_resubscribe", "open", "failed", "click", "skipped_bounced"emailstring (email)Required when parent is presentField path: items[].memberData.emailphonestringRequired when parent is presentField path: items[].memberData.phoneaddressProfileAddressRequired when parent is presentField path: items[].memberData.addressNested fields omitted: depth limit.expiresAtstringRequired when parent is presentField path: items[].expiresAtmetaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/seats' \
--header 'Authorization: Bearer <token>'POST/api/v1/members/{memberId}/subscriptions/product/{id}/create-member
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonfullNamestringOptionalmemberPackageProductIdnumberOptionalminimum: 1emailstring (email)OptionalbirthDatestring (date-time)OptionalnickNamestringOptionalmaxLength: 255phonestringOptionalmaxLength: 32countryCodestringOptionalmaxLength: 8isCompanybooleanOptionalcompanyNamestringOptionalmaxLength: 255addressMemberAddressDtoOptional11 fieldsaddressline1stringOptionalField path: address.line1maxLength: 255line2stringOptionalField path: address.line2maxLength: 255citystringOptionalField path: address.citymaxLength: 255statestringOptionalField path: address.statemaxLength: 255postCodestringOptionalField path: address.postCodemaxLength: 32countrystringOptionalField path: address.countrymaxLength: 64namestringOptionalField path: address.namemaxLength: 255emailstring (email)OptionalField path: address.emailmaxLength: 255organizationNostringOptionalField path: address.organizationNomaxLength: 64companyNamestringOptionalField path: address.companyNamemaxLength: 255invoiceReferencestringOptionalField path: address.invoiceReferencemaxLength: 255customPropertyValuesobjectOptional{
"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": {}
}idstringRequiredfullNamestringRequirednickNamestringRequiredcreatedAtstring (date-time)RequiredavatarstringRequiredcountryCodestringbirthDatestring (date-time)RequireddeleteAfterExpirationbooleanRequiredisCompanybooleanRequiredcompanyNamestringRequiredorganizationNostringRequiredcustomPropertyValuesobjectRequiredemailVerifiedstringphoneVerifiedbooleanRequiredmemberNumbernumberRequireduserIdnumberRequiredemailStatusSENDGRID_MAIL_EVENTS"scheduled", "processed", "dropped", "deferred", "bounce", "hard_bounce", "soft_bounce", "spamreport", "delivered", "unsubscribe", "group_unsubscribe", "group_resubscribe", "open", "failed", "click", "skipped_bounced"emailstring (email)RequiredphonestringRequiredaddressProfileAddressRequired12 fieldsaddressline1stringRequiredField path: address.line1line2stringRequiredField path: address.line2citystringRequiredField path: address.citypostCodestringRequiredField path: address.postCodecountrystringRequiredField path: address.countrynamestringRequiredField path: address.nameemailstringRequiredField path: address.emailcompanyNamestringRequiredField path: address.companyNameorganizationNostringRequiredField path: address.organizationNoinvoiceReferencestringField path: address.invoiceReferenceisSyncedbooleanField path: address.isSyncedlastSyncedAtstring (date-time)Field path: address.lastSyncedAt{
"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"
}
}alreadyExists
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/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": {}
}'POST/api/v1/members/{memberId}/subscriptions/product/{id}/assign-member/{userId}
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequireduserIdstringRequiredSame fields as Create additional member for a product seat (201).
{
"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"
}
}seatLimitReached, cannotAssignToTheOwner, alreadyAssigned
This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/assign-member/{userId}' \
--request POST \
--header 'Authorization: Bearer <token>'POST/api/v1/members/{memberId}/subscriptions/product/{id}/create-gift-receiver
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredsendInvitationbooleanOptionalapplication/jsonfullNamestringRequiredemailstring (email)RequiredphonestringRequiredmemberPackageProductIdnumberOptionalminimum: 1{
"fullName": "<fullName>",
"email": "user@example.com",
"phone": "<phone>",
"memberPackageProductId": 1
}Same fields as Create additional member for a product seat (201).
{
"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"
}
}alreadyExists, seatLimitReached, invitationAlreadyAccepted, invitationAlreadySent, phoneAlreadyVerified
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/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
}'POST/api/v1/members/{memberId}/subscriptions/product/{id}/delivery-address
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonroutestringOptionalmaxLength: 255line1stringOptionalmaxLength: 255line2stringOptionalmaxLength: 255citystringOptionalmaxLength: 255statestringOptionalmaxLength: 255postCodestringOptionalmaxLength: 32countrystringOptionalmaxLength: 64namestringOptionalmaxLength: 255emailstring (email)OptionalmaxLength: 255organizationNostringOptionalmaxLength: 64companyNamestringOptionalmaxLength: 255invoiceReferencestringOptionalmaxLength: 255{
"route": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
}idnumberRequiredroutestringline1stringRequiredline2stringRequiredcitystringRequiredpostCodestringRequiredcountrystringRequirednamestringRequiredemailstringRequiredcompanyNamestringRequiredorganizationNostringRequiredinvoiceReferencestringisSyncedbooleanlastSyncedAtstring (date-time){
"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"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/delivery-address' \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"route": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
}'PATCH/api/v1/members/{memberId}/subscriptions/product/{id}/recurring-price
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsonrecurringPricenumberRequiredminimum: 1{
"recurringPrice": 1
}This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/recurring-price' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"recurringPrice": 1
}'POST/api/v1/members/{memberId}/subscriptions/{id}/invoice-address
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonline1stringOptionalmaxLength: 255line2stringOptionalmaxLength: 255citystringOptionalmaxLength: 255statestringOptionalmaxLength: 255postCodestringOptionalmaxLength: 32countrystringOptionalmaxLength: 64namestringOptionalmaxLength: 255emailstring (email)OptionalmaxLength: 255organizationNostringOptionalmaxLength: 64companyNamestringOptionalmaxLength: 255invoiceReferencestringOptionalmaxLength: 255{
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
}line1stringRequiredline2stringRequiredcitystringRequiredpostCodestringRequiredcountrystringRequirednamestringRequiredemailstringRequiredcompanyNamestringRequiredorganizationNostringRequiredinvoiceReferencestringisSyncedbooleanlastSyncedAtstring (date-time){
"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"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/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"
}'PATCH/api/v1/members/{memberId}/subscriptions/{id}/invoice-address
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonSame fields as Add delivery address of a subscribed package (Request body).
{
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
}Same fields as Add delivery address of a subscribed package (201).
{
"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"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/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"
}'PATCH/api/v1/members/{memberId}/subscriptions/product/{id}/owner-access/{activate}
Authentication: Bearer token (JWT)
idnumberRequiredactivatebooleanRequiredThis response has no body.
alreadyActivated, alreadyDeactivated, seatLimitReached
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/owner-access/{activate}' \
--request PATCH \
--header 'Authorization: Bearer <token>'GET/api/v1/members/{memberId}/subscriptions/product/{id}/delivery-address/{addressId}
Authentication: Bearer token (JWT)
memberIdstringRequiredaddressIdnumberRequiredSame fields as Add delivery address of a subscribed product (201).
{
"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"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/delivery-address/{addressId}' \
--header 'Authorization: Bearer <token>'DELETE/api/v1/members/{memberId}/subscriptions/product/{id}/delivery-address/{addressId}
Authentication: Bearer token (JWT)
addressIdnumberRequiredmemberIdstringRequiredidnumberRequiredThis response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/delivery-address/{addressId}' \
--request DELETE \
--header 'Authorization: Bearer <token>'PATCH/api/v1/members/{memberId}/subscriptions/product/{productId}/delivery-address/{addressId}
Authentication: Bearer token (JWT)
memberIdstringRequiredproductIdnumberRequiredaddressIdnumberRequiredapplication/jsonSame fields as Add delivery address of a subscribed product (Request body).
{
"route": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
}Same fields as Add delivery address of a subscribed product (201).
{
"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"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{productId}/delivery-address/{addressId}' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"route": "string",
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
}'PATCH/api/v1/members/{memberId}/subscriptions/product/{id}/shipping-provider
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonshippingProviderstringRequired"Helthjem", "Bring - Posten", "Distribution Innovation"allowDistributorToUpdateDeliveryAddressbooleanRequired{
"shippingProvider": "Helthjem",
"allowDistributorToUpdateDeliveryAddress": true
}This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/shipping-provider' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"shippingProvider": "Helthjem",
"allowDistributorToUpdateDeliveryAddress": true
}'PATCH/api/v1/members/{memberId}/subscriptions/product/{id}/email-domains
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsonemailDomainsarray of stringOptional{
"emailDomains": [
"string"
]
}memberPackageIdnumberRequiredproductIdnumberRequiredpricenumberRequiredrecurringPricenumberRequiredquantitynumberRequiredhasAccessbooleanRequiredshippingCountrystringRequiredshippingProviderstringRequired"Helthjem", "Bring - Posten", "Distribution Innovation"allowDistributorToUpdateDeliveryAddressbooleanRequiredmemberPackageProductEmailDomainsarray of MemberPackageProductEmailDomainRequired9 fieldsmemberPackageProductEmailDomainsmemberPackageProductIdnumberRequired when parent is presentField path: memberPackageProductEmailDomains[].memberPackageProductIdemailDomainstringRequired when parent is presentField path: memberPackageProductEmailDomains[].emailDomainupdatedBynumberRequired when parent is presentField path: memberPackageProductEmailDomains[].updatedBymemberPackageProductMemberPackageProductRequired when parent is presentField path: memberPackageProductEmailDomains[].memberPackageProductRecursive schema; nested fields are not repeated.idnumberRequired when parent is presentField path: memberPackageProductEmailDomains[].idcreatedAtstring (date-time)Required when parent is presentField path: memberPackageProductEmailDomains[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: memberPackageProductEmailDomains[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: memberPackageProductEmailDomains[].deletedAtmetaDataobjectRequired when parent is presentField path: memberPackageProductEmailDomains[].metaDatamemberPackageProductIpsarray of MemberPackageProductIpRequired10 fieldsmemberPackageProductIpsmemberPackageProductIdnumberRequired when parent is presentField path: memberPackageProductIps[].memberPackageProductIdipRangestringRequired when parent is presentField path: memberPackageProductIps[].ipRangelabelstringRequired when parent is presentField path: memberPackageProductIps[].labelupdatedBynumberRequired when parent is presentField path: memberPackageProductIps[].updatedBymemberPackageProductMemberPackageProductRequired when parent is presentField path: memberPackageProductIps[].memberPackageProductRecursive schema; nested fields are not repeated.idnumberRequired when parent is presentField path: memberPackageProductIps[].idcreatedAtstring (date-time)Required when parent is presentField path: memberPackageProductIps[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: memberPackageProductIps[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: memberPackageProductIps[].deletedAtmetaDataobjectRequired when parent is presentField path: memberPackageProductIps[].metaDatamemberPackageMemberPackageRequired35 fieldsmemberPackagememberIdstringRequiredField path: memberPackage.memberIdpackageIdnumberRequiredField path: memberPackage.packageIdsubscriptionPlanIdnumberRequiredField path: memberPackage.subscriptionPlanIdrecurringPricenumberRequiredField path: memberPackage.recurringPricehasCustomPricebooleanRequiredField path: memberPackage.hasCustomPricecurrentPricenumberRequiredField path: memberPackage.currentPricestatusstringRequiredField path: memberPackage.status"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"autoRenewbooleanRequiredField path: memberPackage.autoRenewnextRenewalstring (date-time)RequiredField path: memberPackage.nextRenewalrenewalAnchorDatestring (date-time)RequiredField path: memberPackage.renewalAnchorDatecurrentPeriodStartstring (date-time)RequiredField path: memberPackage.currentPeriodStartforcedStopDatestring (date-time)RequiredField path: memberPackage.forcedStopDatecancelledAtstring (date-time)RequiredField path: memberPackage.cancelledAtisCustomizedbooleanRequiredField path: memberPackage.isCustomizedpaymentProviderstringRequiredField path: memberPackage.paymentProvider"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"referencestringRequiredField path: memberPackage.referencelastActiveAtstring (date-time)RequiredField path: memberPackage.lastActiveAtisOnIntroPeriodbooleanRequiredField path: memberPackage.isOnIntroPeriodnextOrderDatestring (date-time)RequiredField path: memberPackage.nextOrderDatescheduledActivationDatestring (date-time)RequiredField path: memberPackage.scheduledActivationDatepackagePackageRequiredField path: memberPackage.packageNested fields omitted: field limit.subscriptionPlanSubscriptionPlanRequiredField path: memberPackage.subscriptionPlanNested fields omitted: field limit.memberMemberRequiredField path: memberPackage.memberNested fields omitted: field limit.memberPackageProductsarray of MemberPackageProductRequiredField path: memberPackage.memberPackageProductsRecursive schema; nested fields are not repeated.ordersarray of OrderRequiredField path: memberPackage.ordersNested fields omitted: field limit.memberPackageProviderPaymentMemberPackageProviderPaymentRequiredField path: memberPackage.memberPackageProviderPaymentNested fields omitted: field limit.changesarray of MemberPackageChangeRequiredField path: memberPackage.changesNested fields omitted: field limit.historiesarray of MemberPackageHistoryRequiredField path: memberPackage.historiesNested fields omitted: field limit.tenantIdnumberRequiredField path: memberPackage.tenantIdtenantTenantRequiredField path: memberPackage.tenantNested fields omitted: field limit.idnumberRequiredField path: memberPackage.idcreatedAtstring (date-time)RequiredField path: memberPackage.createdAtupdatedAtstring (date-time)RequiredField path: memberPackage.updatedAtdeletedAtstring (date-time)RequiredField path: memberPackage.deletedAtmetaDataobjectRequiredField path: memberPackage.metaDataproductProductRequiredNested fields omitted: field limit.seatsarray of MemberPackageProductSeatRequiredNested fields omitted: field limit.recipientsarray of MemberPackageProductRecipientRequiredNested fields omitted: field limit.idnumberRequiredcreatedAtstring (date-time)RequiredupdatedAtstring (date-time)RequireddeletedAtstring (date-time)RequiredmetaDataobjectRequired{
"memberPackageId": 0,
"productId": 0,
"price": 0,
"recurringPrice": 0,
"quantity": 0,
"hasAccess": true,
"shippingCountry": "string",
"shippingProvider": "Helthjem",
"allowDistributorToUpdateDeliveryAddress": true,
"memberPackageProductEmailDomains": [
{
"metaData": {}
}
],
"memberPackageProductIps": [
{
"metaData": {}
}
],
"memberPackage": {
"memberId": "string",
"packageId": 0,
"subscriptionPlanId": 0,
"recurringPrice": 0,
"hasCustomPrice": true,
"currentPrice": 0,
"status": "active",
"autoRenew": true,
"nextRenewal": "2019-08-24T14:15:22Z",
"renewalAnchorDate": "2019-08-24T14:15:22Z",
"currentPeriodStart": "2019-08-24T14:15:22Z",
"forcedStopDate": "2019-08-24T14:15:22Z",
"cancelledAt": "2019-08-24T14:15:22Z",
"isCustomized": true,
"paymentProvider": "stripe",
"reference": "string",
"lastActiveAt": "2019-08-24T14:15:22Z",
"isOnIntroPeriod": true,
"nextOrderDate": "2019-08-24T14:15:22Z",
"scheduledActivationDate": "2019-08-24T14:15:22Z",
"package": {
"paymentProviders": [],
"description": {},
"packageProducts": [],
"payments": [],
"memberPackages": [],
"metaData": {}
},
"subscriptionPlan": {
"paymentProviders": [],
"entityTags": [],
"subscriptionPlanProducts": [],
"packages": [],
"memberPackages": [],
"metaData": {}
},
"member": {
"customPropertyValues": {},
"productRecipients": [],
"metaData": {}
},
"memberPackageProducts": [],
"orders": [],
"memberPackageProviderPayment": {
"paymentInfo": {},
"cardInfo": {},
"metaData": {}
},
"changes": [],
"histories": [],
"tenantId": 0,
"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": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"product": {
"productCategory": "digital_subscription",
"tenantId": 0,
"name": "string",
"uuid": "string",
"isOptional": true,
"price": 0,
"currency": "string",
"tax": 0,
"stock": 0,
"maxQuantityPerOrder": 0,
"ean": "string",
"allowFutureStartDate": true,
"assignSeatToOwner": true,
"supportsIpAccess": true,
"status": "draft",
"properties": {},
"shippingCharges": [],
"description": "string",
"circulationType": "subscription",
"publicationDays": "string",
"diProductCode": "string",
"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": [],
"packageProducts": [],
"memberPackageProducts": [],
"orderItem": [],
"productContents": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"seats": [
{
"metaData": {}
}
],
"recipients": [
{
"metaData": {}
}
],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}invalidEmailDomains
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/email-domains' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"emailDomains": [
"string"
]
}'DELETE/api/v1/members/{memberId}/subscriptions/product/{id}/email-domains/{domain}
Authentication: Bearer token (JWT)
idnumberRequireddomainstringRequiredThis response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/email-domains/{domain}' \
--request DELETE \
--header 'Authorization: Bearer <token>'PUT/api/v1/members/{memberId}/subscriptions/product/{id}/ip-ranges
Authentication: Bearer token (JWT)
idnumberRequiredapplication/jsonipRangesarray of IpRangeInputDtoRequired1 required when the containing object is present2 fieldsipRangesvaluestringRequired when parent is presentField path: ipRanges[].valuelabelstringOptionalField path: ipRanges[].labelmaxLength: 120ipRangestringRequired when parent is presentlabelstring[
{
"ipRange": "string",
"label": "string"
}
]invalidIpRanges
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/ip-ranges' \
--request PUT \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"ipRanges": [
{}
]
}'DELETE/api/v1/members/{memberId}/subscriptions/product/{id}/ip-ranges/{ipRange}
Authentication: Bearer token (JWT)
idnumberRequiredipRangestringRequiredThis response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/product/{id}/ip-ranges/{ipRange}' \
--request DELETE \
--header 'Authorization: Bearer <token>'GET/api/v1/members/{memberId}/subscriptions/seats/{id}
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredidnumberRequirednamestringRequiredemailstringRequiredstatusstringRequired"pending", "accepted", "expired", "awaiting_activation"memberIdstringRequiredmemberDataMemberPersonalInfoRequired20 fieldsmemberDataidstringRequiredField path: memberData.idfullNamestringRequiredField path: memberData.fullNamenickNamestringRequiredField path: memberData.nickNamecreatedAtstring (date-time)RequiredField path: memberData.createdAtavatarstringRequiredField path: memberData.avatarcountryCodestringField path: memberData.countryCodebirthDatestring (date-time)RequiredField path: memberData.birthDatedeleteAfterExpirationbooleanRequiredField path: memberData.deleteAfterExpirationisCompanybooleanRequiredField path: memberData.isCompanycompanyNamestringRequiredField path: memberData.companyNameorganizationNostringRequiredField path: memberData.organizationNocustomPropertyValuesobjectRequiredField path: memberData.customPropertyValuesemailVerifiedstringField path: memberData.emailVerifiedphoneVerifiedbooleanRequiredField path: memberData.phoneVerifiedmemberNumbernumberRequiredField path: memberData.memberNumberuserIdnumberRequiredField path: memberData.userIdemailStatusSENDGRID_MAIL_EVENTSField path: memberData.emailStatus"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.emailphonestringRequiredField path: memberData.phoneaddressProfileAddressRequiredField path: memberData.address12 fieldsmemberData.addressline1stringRequiredField path: memberData.address.line1line2stringRequiredField path: memberData.address.line2citystringRequiredField path: memberData.address.citypostCodestringRequiredField path: memberData.address.postCodecountrystringRequiredField path: memberData.address.countrynamestringRequiredField path: memberData.address.nameemailstringRequiredField path: memberData.address.emailcompanyNamestringRequiredField path: memberData.address.companyNameorganizationNostringRequiredField path: memberData.address.organizationNoinvoiceReferencestringField path: memberData.address.invoiceReferenceisSyncedbooleanField path: memberData.address.isSyncedlastSyncedAtstring (date-time)Field path: memberData.address.lastSyncedAtexpiresAtstringRequired{
"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"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/seats/{id}' \
--header 'Authorization: Bearer <token>'DELETE/api/v1/members/{memberId}/subscriptions/seats/{id}
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredThis response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/seats/{id}' \
--request DELETE \
--header 'Authorization: Bearer <token>'POST/api/v1/members/{memberId}/subscriptions/seats/invite
Authentication: Bearer token (JWT)
memberIdstringRequiredapplication/jsonemailstring (email)RequiredidnumberRequiredminimum: 1{
"email": "user@example.com",
"id": 1
}memberPackageProductIdnumberRequiredmemberIdstringRequiredemailstringRequiredacceptedbooleanRequiredacceptedAtstring (date-time)RequiredexpiresAtstring (date-time)RequireduuidstringRequiredmemberPackageProductMemberPackageProductRequired20 fieldsmemberPackageProductmemberPackageIdnumberRequiredField path: memberPackageProduct.memberPackageIdproductIdnumberRequiredField path: memberPackageProduct.productIdpricenumberRequiredField path: memberPackageProduct.pricerecurringPricenumberRequiredField path: memberPackageProduct.recurringPricequantitynumberRequiredField path: memberPackageProduct.quantityhasAccessbooleanRequiredField path: memberPackageProduct.hasAccessshippingCountrystringRequiredField path: memberPackageProduct.shippingCountryshippingProviderstringRequiredField path: memberPackageProduct.shippingProvider"Helthjem", "Bring - Posten", "Distribution Innovation"allowDistributorToUpdateDeliveryAddressbooleanRequiredField path: memberPackageProduct.allowDistributorToUpdateDeliveryAddressmemberPackageProductEmailDomainsarray of MemberPackageProductEmailDomainRequiredField path: memberPackageProduct.memberPackageProductEmailDomains9 fieldsmemberPackageProduct.memberPackageProductEmailDomainsmemberPackageProductIdnumberRequired when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].memberPackageProductIdemailDomainstringRequired when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].emailDomainupdatedBynumberRequired when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].updatedBymemberPackageProductMemberPackageProductRequired when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].memberPackageProductRecursive schema; nested fields are not repeated.idnumberRequired when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].idcreatedAtstring (date-time)Required when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].deletedAtmetaDataobjectRequired when parent is presentField path: memberPackageProduct.memberPackageProductEmailDomains[].metaDatamemberPackageProductIpsarray of MemberPackageProductIpRequiredField path: memberPackageProduct.memberPackageProductIps10 fieldsmemberPackageProduct.memberPackageProductIpsmemberPackageProductIdnumberRequired when parent is presentField path: memberPackageProduct.memberPackageProductIps[].memberPackageProductIdipRangestringRequired when parent is presentField path: memberPackageProduct.memberPackageProductIps[].ipRangelabelstringRequired when parent is presentField path: memberPackageProduct.memberPackageProductIps[].labelupdatedBynumberRequired when parent is presentField path: memberPackageProduct.memberPackageProductIps[].updatedBymemberPackageProductMemberPackageProductRequired when parent is presentField path: memberPackageProduct.memberPackageProductIps[].memberPackageProductRecursive schema; nested fields are not repeated.idnumberRequired when parent is presentField path: memberPackageProduct.memberPackageProductIps[].idcreatedAtstring (date-time)Required when parent is presentField path: memberPackageProduct.memberPackageProductIps[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: memberPackageProduct.memberPackageProductIps[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: memberPackageProduct.memberPackageProductIps[].deletedAtmetaDataobjectRequired when parent is presentField path: memberPackageProduct.memberPackageProductIps[].metaDatamemberPackageMemberPackageRequiredField path: memberPackageProduct.memberPackageNested fields omitted: field limit.productProductRequiredField path: memberPackageProduct.productNested fields omitted: field limit.seatsarray of MemberPackageProductSeatRequiredField path: memberPackageProduct.seatsRecursive schema; nested fields are not repeated.recipientsarray of MemberPackageProductRecipientRequiredField path: memberPackageProduct.recipientsNested fields omitted: field limit.idnumberRequiredField path: memberPackageProduct.idcreatedAtstring (date-time)RequiredField path: memberPackageProduct.createdAtupdatedAtstring (date-time)RequiredField path: memberPackageProduct.updatedAtdeletedAtstring (date-time)RequiredField path: memberPackageProduct.deletedAtmetaDataobjectRequiredField path: memberPackageProduct.metaDatamemberMemberRequired21 fieldsmemberuserIdnumberRequiredField path: member.userIdmemberNumbernumberRequiredField path: member.memberNumbertenantIdnumberRequiredField path: member.tenantIdexternalIdstringRequiredField path: member.externalIdfullNamestringRequiredField path: member.fullNamenickNamestringRequiredField path: member.nickNameavatarstringRequiredField path: member.avataremailstringRequiredField path: member.emailbirthDatestring (date-time)RequiredField path: member.birthDatephonestringRequiredField path: member.phoneisCompanybooleanRequiredField path: member.isCompanycompanyNamestringRequiredField path: member.companyNameorganizationNostringRequiredField path: member.organizationNodeleteAfterExpirationbooleanRequiredField path: member.deleteAfterExpirationcustomPropertyValuesobjectRequiredField path: member.customPropertyValuesproductRecipientsarray of MemberPackageProductRecipientRequiredField path: member.productRecipientsNested fields omitted: field limit.idstringRequiredField path: member.idcreatedAtstring (date-time)RequiredField path: member.createdAtupdatedAtstring (date-time)RequiredField path: member.updatedAtdeletedAtstring (date-time)RequiredField path: member.deletedAtmetaDataobjectRequiredField path: member.metaDataidnumberRequiredcreatedAtstring (date-time)RequiredupdatedAtstring (date-time)RequireddeletedAtstring (date-time)RequiredmetaDataobjectRequired{
"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": {}
}cannotInviteYourself, invitationNotSupported, invitationLimitReached,invitationAlreadyAccepted, invitationAlreadySent
This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/seats/invite' \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"email": "user@example.com",
"id": 1
}'POST/api/v1/members/{memberId}/subscriptions/seats/{seatId}/resend
Authentication: Bearer token (JWT)
memberIdstringRequiredseatIdnumberRequiredSame fields as Invite member to a product seat (201).
{
"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": {}
}invitationLimitReached, invitationAlreadyAccepted, invitationAlreadySent
This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/seats/{seatId}/resend' \
--request POST \
--header 'Authorization: Bearer <token>'POST/api/v1/members/{memberId}/subscriptions/free
Authentication: Bearer token (JWT)
memberIdstringRequiredapplication/jsonpackageIdnumberRequiredemailstringOptional{
"packageId": 0,
"email": "string"
}This response has no body.
invalidPackage, badRequest
This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/free' \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"packageId": 0,
"email": "string"
}'POST/api/v1/members/{memberId}/subscriptions/faktura
Authentication: Bearer token (JWT)
memberIdstringRequiredapplication/jsonpackageIdnumberRequiredpaidPaymentProviderstringOptional"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"paymentDatestring (date-time)OptionalisPaidbooleanOptionalnotestringOptionaloptionalProductsarray of OptionalProductWithQuantityOptional2 required when the containing object is present4 fieldsoptionalProductsproductIdnumberRequired when parent is presentField path: optionalProducts[].productIdminimum: 1quantitynumberRequired when parent is presentField path: optionalProducts[].quantityminimum: 1shippingCountrystringOptionalField path: optionalProducts[].shippingCountrymaxLength: 64manualPricenumberOptionalField path: optionalProducts[].manualPricemainProductsWithManualPricearray of MainProductWithManualPriceOptional2 required when the containing object is present2 fieldsmainProductsWithManualPriceproductIdnumberRequired when parent is presentField path: mainProductsWithManualPrice[].productIdmanualPricenumberRequired when parent is presentField path: mainProductsWithManualPrice[].manualPriceminimum: 1userDataFakturaCheckoutUserRequired12 fieldsuserDatamemberIdstringOptionalField path: userData.memberIdemailstring (email)OptionalField path: userData.emailfullNamestringRequiredField path: userData.fullNamephonestringOptionalField path: userData.phonemaxLength: 20countryCodestringOptionalField path: userData.countryCode"NO", "SE", "DK", "FI", "FO", "GB"isCompanybooleanOptionalField path: userData.isCompanycompanyNamestringOptionalField path: userData.companyNameorganizationNostringOptionalField path: userData.organizationNoreferencestringOptionalField path: userData.referenceonCheckoutCompletedUrlstringOptionalField path: userData.onCheckoutCompletedUrlsourceUrlstringOptionalField path: userData.sourceUrlreferrerUrlstringOptionalField path: userData.referrerUrlbillingAddressBillingAddressOptional3 required when the containing object is present11 fieldsbillingAddressaddressstringRequired when parent is presentField path: billingAddress.addressaddressTwostringOptionalField path: billingAddress.addressTwocompanyNamestringOptionalField path: billingAddress.companyNameorganizationNostringOptionalField path: billingAddress.organizationNopostCodestringRequired when parent is presentField path: billingAddress.postCodecitystringOptionalField path: billingAddress.citycountrystringRequired when parent is presentField path: billingAddress.countryinvoiceReferencestringOptionalField path: billingAddress.invoiceReferenceemailstringOptionalField path: billingAddress.emailfullNamestringOptionalField path: billingAddress.fullNamephonestringOptionalField path: billingAddress.phone{
"packageId": 0,
"paidPaymentProvider": "stripe",
"paymentDate": "2019-08-24T14:15:22Z",
"isPaid": true,
"note": "string",
"userData": {
"memberId": "string",
"email": "user@example.com",
"fullName": "<fullName>",
"phone": "<phone>",
"countryCode": "NO",
"isCompany": true,
"companyName": "string",
"organizationNo": "string",
"reference": "string",
"onCheckoutCompletedUrl": "string",
"sourceUrl": "string",
"referrerUrl": "string"
},
"billingAddress": {
"address": "<address>",
"addressTwo": "<addressTwo>",
"companyName": "string",
"organizationNo": "string",
"postCode": "string",
"city": "string",
"country": "string",
"invoiceReference": "string",
"email": "string",
"fullName": "<fullName>",
"phone": "<phone>"
}
}This response has no body.
invalidPackage, badRequest
This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/faktura' \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"packageId": 0,
"paidPaymentProvider": "stripe",
"paymentDate": "2019-08-24T14:15:22Z",
"isPaid": true,
"note": "string",
"optionalProducts": [
{}
],
"mainProductsWithManualPrice": [
{}
],
"userData": {
"memberId": "string",
"email": "user@example.com",
"fullName": "<fullName>",
"phone": "<phone>",
"countryCode": "NO",
"isCompany": true,
"companyName": "string",
"organizationNo": "string",
"reference": "string",
"onCheckoutCompletedUrl": "string",
"sourceUrl": "string",
"referrerUrl": "string"
},
"billingAddress": {
"address": "<address>",
"addressTwo": "<addressTwo>",
"companyName": "string",
"organizationNo": "string",
"postCode": "string",
"city": "string",
"country": "string",
"invoiceReference": "string",
"email": "string",
"fullName": "<fullName>",
"phone": "<phone>"
}
}'PATCH/api/v1/members/{memberId}/subscriptions/faktura/update
Authentication: Bearer token (JWT)
memberIdstringRequiredapplication/jsonmemPackIdnumberRequiredpaymentDatestring (date-time)OptionalisPaidbooleanOptionalnotestringOptionalpaymentProviderstringOptional"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"{
"memPackId": 0,
"paymentDate": "2019-08-24T14:15:22Z",
"isPaid": true,
"note": "string",
"paymentProvider": "stripe"
}packageIdnumberRequiredaccountingDatestring (date-time)RequiredregistrationDatestring (date-time)RequiredpaymentProviderstringRequired"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"paymentMethodstringRequired"card", "vipps", "manual_registration", "efaktura", "ehf", "avtalegiro"amountnumberRequiredcurrencystringRequiredstatusstringRequired"pending", "succeeded", "failed"notestringRequiredisAdminActionbooleanRequiredmemberIdstringRequiredstripePaymentStripePaymentRequired14 fieldsstripePaymentpaymentIdnumberRequiredField path: stripePayment.paymentIdemailstringRequiredField path: stripePayment.emailcustomerIdstringRequiredField path: stripePayment.customerIdpaymentMethodIdstringRequiredField path: stripePayment.paymentMethodIdpaymentIntentIdstringRequiredField path: stripePayment.paymentIntentIdstatusstringRequiredField path: stripePayment.status"requires_payment_method", "requires_confirmation", "requires_action", "processing", "requires_capture", "canceled", "succeeded"isSavedbooleanRequiredField path: stripePayment.isSavedcardInfoStripeCardInfoRequiredField path: stripePayment.cardInfoNested fields omitted: field limit.paymentPaymentRequiredField path: stripePayment.paymentRecursive schema; nested fields are not repeated.idnumberRequiredField path: stripePayment.idcreatedAtstring (date-time)RequiredField path: stripePayment.createdAtupdatedAtstring (date-time)RequiredField path: stripePayment.updatedAtdeletedAtstring (date-time)RequiredField path: stripePayment.deletedAtmetaDataobjectRequiredField path: stripePayment.metaDatavippsPaymentVippsPaymentRequired20 fieldsvippsPaymentuuidstringRequiredField path: vippsPayment.uuidagreementIdstringRequiredField path: vippsPayment.agreementIdexternalIdstringRequiredField path: vippsPayment.externalIdphonestringRequiredField path: vippsPayment.phonechargeIdstringRequiredField path: vippsPayment.chargeIdduestring (date-time)RequiredField path: vippsPayment.duetransactionIdstringRequiredField path: vippsPayment.transactionIdvippsConfirmationUrlstringRequiredField path: vippsPayment.vippsConfirmationUrlfailureReasonstringRequiredField path: vippsPayment.failureReasonfailureDescriptionstringRequiredField path: vippsPayment.failureDescriptionstatusstringRequiredField path: vippsPayment.status"PENDING", "ACTIVE", "STOPPED", "EXPIRED", "DUE", "CHARGED", "RESERVED", "PARTIALLY_CAPTURED", "FAILED", "CANCELLED", "PARTIALLY_REFUNDED", "REFUNDED", "PROCESSING", "CHARGE_CREATION_FAILED"summarystringRequiredField path: vippsPayment.summaryhistorystringRequiredField path: vippsPayment.historypaymentIdnumberRequiredField path: vippsPayment.paymentIdpaymentPaymentRequiredField path: vippsPayment.paymentRecursive schema; nested fields are not repeated.idnumberRequiredField path: vippsPayment.idcreatedAtstring (date-time)RequiredField path: vippsPayment.createdAtupdatedAtstring (date-time)RequiredField path: vippsPayment.updatedAtdeletedAtstring (date-time)RequiredField path: vippsPayment.deletedAtmetaDataobjectRequiredField path: vippsPayment.metaDatanetsPaymentNetsPaymentRequired18 fieldsnetsPaymentemailstringRequiredField path: netsPayment.emailuuidstringRequiredField path: netsPayment.uuidpaymentIntentIdstringRequiredField path: netsPayment.paymentIntentIdreferencestringRequiredField path: netsPayment.referencestatusstringRequiredField path: netsPayment.status"pending", "succeeded", "failed"isRecurringbooleanRequiredField path: netsPayment.isRecurringisRestartByCardUpdatebooleanRequiredField path: netsPayment.isRestartByCardUpdatechargeIdstringRequiredField path: netsPayment.chargeIdbulkIdstringRequiredField path: netsPayment.bulkIdsubscriptionIdstringRequiredField path: netsPayment.subscriptionIdcardInfoNetsCardInfoRequiredField path: netsPayment.cardInfopaymentIdnumberRequiredField path: netsPayment.paymentIdpaymentPaymentRequiredField path: netsPayment.paymentRecursive schema; nested fields are not repeated.idnumberRequiredField path: netsPayment.idcreatedAtstring (date-time)RequiredField path: netsPayment.createdAtupdatedAtstring (date-time)RequiredField path: netsPayment.updatedAtdeletedAtstring (date-time)RequiredField path: netsPayment.deletedAtmetaDataobjectRequiredField path: netsPayment.metaDataeInvoicePaymentEInvoicePaymentRequiredNested fields omitted: field limit.swedbankpayPaymentSwedbankpayPaymentRequiredNested fields omitted: field limit.packagePackageRequiredNested fields omitted: field limit.orderOrderRequiredNested fields omitted: field limit.checkoutStateCheckoutStateRequiredNested fields omitted: field limit.invoiceIdnumberRequiredinvoiceInvoiceRequiredNested fields omitted: field limit.memberMemberRequiredNested fields omitted: field limit.updatedBynumberRequiredidnumberRequiredcreatedAtstring (date-time)RequiredupdatedAtstring (date-time)RequireddeletedAtstring (date-time)RequiredmetaDataobjectRequired{
"packageId": 0,
"accountingDate": "2019-08-24T14:15:22Z",
"registrationDate": "2019-08-24T14:15:22Z",
"paymentProvider": "stripe",
"paymentMethod": "card",
"amount": 0,
"currency": "string",
"status": "pending",
"note": "string",
"isAdminAction": true,
"memberId": "string",
"stripePayment": {
"paymentId": 0,
"email": "string",
"customerId": "string",
"paymentMethodId": "string",
"paymentIntentId": "string",
"status": "requires_payment_method",
"isSaved": true,
"cardInfo": {},
"payment": {},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"vippsPayment": {
"uuid": "string",
"agreementId": "string",
"externalId": "string",
"phone": "<phone>",
"chargeId": "string",
"due": "2019-08-24T14:15:22Z",
"transactionId": "string",
"vippsConfirmationUrl": "string",
"failureReason": "string",
"failureDescription": "string",
"status": "PENDING",
"summary": "string",
"history": "string",
"paymentId": 0,
"payment": {},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"netsPayment": {
"email": "string",
"uuid": "string",
"paymentIntentId": "string",
"reference": "string",
"status": "pending",
"isRecurring": true,
"isRestartByCardUpdate": true,
"chargeId": "string",
"bulkId": "string",
"subscriptionId": "string",
"cardInfo": {},
"paymentId": 0,
"payment": {},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"eInvoicePayment": {
"kid": "string",
"status": "PENDING",
"channel": "Efaktura 2.0",
"summary": "string",
"xml": "string",
"invoiceId": 0,
"paymentId": 0,
"invoice": {
"orderItemInfo": [],
"taxGroupInfo": [],
"refunds": [],
"creditNotes": [],
"payments": [],
"metaData": {}
},
"payment": {},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"swedbankpayPayment": {
"email": "string",
"uuid": "string",
"paymentIntentId": "string",
"reference": "string",
"status": "pending",
"isRecurring": true,
"isRestartByCardUpdate": true,
"chargeId": "string",
"subscriptionId": "string",
"cardInfo": {},
"paymentId": 0,
"payment": {},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"package": {
"paymentProviders": [],
"repeatPurchaseControl": "allow",
"repeatPurchaseCooldownDays": 0,
"displayOrder": 0,
"seo": {},
"salesTitle": "string",
"uuid": "string",
"subscriptionPlanId": 0,
"slug": "string",
"image": "string",
"name": "string",
"description": {},
"billingPeriod": "monthly",
"billingPeriodUnit": "day",
"billingPeriodFrequency": 0,
"status": "draft",
"isAvailableOnMyPage": true,
"isAvailableViaSlug": true,
"isAvailableForManualOrderViaAdmin": true,
"allowSameSubscriptionChange": true,
"allowDifferentSubscriptionSwitch": true,
"tenantId": 0,
"onboardingWelcomeRedirectCTAText": {},
"customPeriodText": {},
"orderCtaLabel": {},
"introPeriodFixedEndDate": "2019-08-24T14:15:22Z",
"packageProducts": [],
"subscriptionPlan": {
"paymentProviders": [],
"entityTags": [],
"subscriptionPlanProducts": [],
"packages": [],
"memberPackages": [],
"metaData": {}
},
"payments": [],
"memberPackages": [],
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"order": {
"orderNumber": 0,
"memberPackageId": 0,
"recurringPriceAtOrder": 0,
"paymentId": 0,
"paymentToken": "<paymentToken>",
"type": "initial",
"orderItems": [],
"payment": {},
"memberPackage": {
"memberPackageProducts": [],
"orders": [],
"changes": [],
"histories": [],
"metaData": {}
},
"invoice": {
"orderItemInfo": [],
"taxGroupInfo": [],
"refunds": [],
"creditNotes": [],
"payments": [],
"metaData": {}
},
"tenantId": 0,
"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": {}
},
"memberPackageChange": {
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"checkoutState": {
"uuid": "string",
"memberId": "string",
"status": "created",
"steps": [],
"paymentData": {},
"memberData": {
"customPropertyValues": {}
},
"additionalMemberData": [],
"physicalProductData": {
"memberAddressData": [],
"productData": []
},
"giftReceiverData": [],
"giftReceiverDeliveryData": {
"giftReceiverAddressData": [],
"productData": []
},
"paymentId": 0,
"memberPackageId": 0,
"payment": {},
"member": {
"customPropertyValues": {},
"productRecipients": [],
"metaData": {}
},
"memberPackage": {
"memberPackageProducts": [],
"orders": [],
"changes": [],
"histories": [],
"metaData": {}
},
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
},
"invoiceId": 0,
"invoice": {
"status": "paid",
"deliveryStatus": "sent_via_einvoice",
"remainingAmount": 0,
"totalTaxAmount": 0,
"taxExclusiveAmount": 0,
"invoiceNumber": 0,
"language": "en",
"packName": "string",
"planName": "string",
"autoGenerated": true,
"periodStartDate": "2019-08-24T14:15:22Z",
"periodEndDate": "2019-08-24T14:15:22Z",
"memberInfo": {},
"addressInfo": {},
"tenantInfo": {},
"orderNumber": 0,
"orderItemInfo": [],
"taxGroupInfo": [],
"paymentProvider": "stripe",
"paymentMethod": "card",
"amount": 0,
"paidAmount": 0,
"dueDate": "2019-08-24T14:15:22Z",
"paymentDate": "2019-08-24T14:15:22Z",
"accountingDate": "2019-08-24T14:15:22Z",
"currency": "string",
"tenantId": 0,
"order": {
"orderItems": [],
"metaData": {}
},
"eInvoicePayment": {
"metaData": {}
},
"member": {
"customPropertyValues": {},
"productRecipients": [],
"metaData": {}
},
"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": {}
},
"refunds": [],
"isCreditNote": true,
"note": "string",
"referencedInvoiceNumber": 0,
"referencedInvoiceId": 0,
"referencedInvoice": {},
"creditNotes": [],
"payments": [],
"transaction": {
"metaData": {}
},
"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": {}
},
"updatedBy": 0,
"id": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"metaData": {}
}invalidPackage, badRequest
This response has no body.
unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/faktura/update' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"memPackId": 0,
"paymentDate": "2019-08-24T14:15:22Z",
"isPaid": true,
"note": "string",
"paymentProvider": "stripe"
}'POST/api/v1/members/{memberId}/subscriptions/subscription-plan/price-by-quantity
Authentication: Bearer token (JWT)
memberIdstringRequiredapplication/jsonplanIdnumberRequiredminimum: 1productsarray of OptionalProductWithQuantityRequired2 required when the containing object is present4 fieldsproductsproductIdnumberRequired when parent is presentField path: products[].productIdminimum: 1quantitynumberRequired when parent is presentField path: products[].quantityminimum: 1shippingCountrystringOptionalField path: products[].shippingCountrymaxLength: 64manualPricenumberOptionalField path: products[].manualPricememberPackageIdnumberOptionalpaymentProvidersarray of PAYMENT_PROVIDERRequired"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"namestringRequireduuidstringRequiredbillingPeriodstringRequired"monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"billingPeriodUnitstringRequired"day", "week", "month", "year"billingPeriodFrequencynumberRequiredautoRenewbooleanRequiredstatusstringRequired"draft", "published", "archived"tenantIdnumberRequiredallowSameSubscriptionChangebooleanRequiredallowDifferentSubscriptionSwitchbooleanRequiredallowAdminSameSubscriptionChangebooleanRequiredallowAdminDifferentSubscriptionSwitchbooleanRequiredenableGiftSubscriptionbooleanRequiredallowFutureStartDatebooleanRequiredshowAsOptionOnSubscriptionSwitchbooleanRequiredshowAsOptionOnAdminSubscriptionSwitchbooleanRequiredofferSwitchOnCheckoutbooleanRequiredtenantTenantRequiredNested fields omitted: field limit.entityTagsarray of EntityTagRequired13 fieldsentityTagsproductIdnumberRequired when parent is presentField path: entityTags[].productIdtagIdnumberRequired when parent is presentField path: entityTags[].tagIdsubscriptionPlanIdnumberRequired when parent is presentField path: entityTags[].subscriptionPlanIdtagTagRequired when parent is presentField path: entityTags[].tagNested fields omitted: field limit.productProductRequired when parent is presentField path: entityTags[].productNested fields omitted: field limit.subscriptionPlanSubscriptionPlanRequired when parent is presentField path: entityTags[].subscriptionPlanNested fields omitted: field limit.visualWorkflowIdnumberRequired when parent is presentField path: entityTags[].visualWorkflowIdvisualWorkflowVisualWorkflowRequired when parent is presentField path: entityTags[].visualWorkflowNested fields omitted: field limit.idnumberRequired when parent is presentField path: entityTags[].idcreatedAtstring (date-time)Required when parent is presentField path: entityTags[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: entityTags[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: entityTags[].deletedAtmetaDataobjectRequired when parent is presentField path: entityTags[].metaDatasubscriptionPlanProductsarray of SubscriptionPlanProductRequired13 fieldssubscriptionPlanProductssubscriptionPlanIdnumberRequired when parent is presentField path: subscriptionPlanProducts[].subscriptionPlanIdproductIdnumberRequired when parent is presentField path: subscriptionPlanProducts[].productIdpricenumberRequired when parent is presentField path: subscriptionPlanProducts[].pricepropertiesOptionalProductPropertiesRequired when parent is presentField path: subscriptionPlanProducts[].properties2 fieldssubscriptionPlanProducts[].propertiesisRequiredbooleanRequired when parent is presentField path: subscriptionPlanProducts[].properties.isRequiredquantityRangenumberRequired when parent is presentField path: subscriptionPlanProducts[].properties.quantityRangesubscriptionPlanSubscriptionPlanRequired when parent is presentField path: subscriptionPlanProducts[].subscriptionPlanNested fields omitted: field limit.productProductRequired when parent is presentField path: subscriptionPlanProducts[].productNested fields omitted: field limit.tenantIdnumberRequired when parent is presentField path: subscriptionPlanProducts[].tenantIdtenantTenantRequired when parent is presentField path: subscriptionPlanProducts[].tenantNested fields omitted: field limit.idnumberRequired when parent is presentField path: subscriptionPlanProducts[].idcreatedAtstring (date-time)Required when parent is presentField path: subscriptionPlanProducts[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: subscriptionPlanProducts[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: subscriptionPlanProducts[].deletedAtmetaDataobjectRequired when parent is presentField path: subscriptionPlanProducts[].metaDatapackagesarray of PackageRequiredNested fields omitted: field limit.memberPackagesarray of MemberPackageRequiredNested fields omitted: field limit.idnumberRequiredcreatedAtstring (date-time)RequiredupdatedAtstring (date-time)RequireddeletedAtstring (date-time)RequiredmetaDataobjectRequiredsubscriptionCountnumberRequiredproductsarray of SubscriptionProductRequired13 fieldsproductscirculationTypeCIRCULATION_TYPEField path: products[].circulationType"subscription", "single_copy"productIdnumberRequired when parent is presentField path: products[].productIdnamestringRequired when parent is presentField path: products[].namepricenumberRequired when parent is presentField path: products[].pricecurrencystringRequired when parent is presentField path: products[].currencyisOptionalbooleanRequired when parent is presentField path: products[].isOptionalbasePricenumberRequired when parent is presentField path: products[].basePricepropertiesOptionalProductPropertiesRequired when parent is presentField path: products[].properties2 fieldsproducts[].propertiesisRequiredbooleanRequired when parent is presentField path: products[].properties.isRequiredquantityRangenumberRequired when parent is presentField path: products[].properties.quantityRangeshippingChargesarray of ShippingChargeRequired when parent is presentField path: products[].shippingCharges2 fieldsproducts[].shippingChargescountrystringRequired when parent is presentField path: products[].shippingCharges[].countrychargenumberRequired when parent is presentField path: products[].shippingCharges[].chargeproductCategorystringRequired when parent is presentField path: products[].productCategory"digital_subscription", "physical_subscription", "physical", "event_ticket", "PHYSICAL_PRODUCT"taxnumberRequired when parent is presentField path: products[].taxdescriptionstringRequired when parent is presentField path: products[].descriptionmaxQuantityPerOrdernumberRequired when parent is presentField path: products[].maxQuantityPerOrdertagsarray of stringpricenumberRequiredhasOptionalProductsbooleanRequired{
"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
}invalidProducts
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/subscription-plan/price-by-quantity' \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"planId": 1,
"products": [
{}
],
"memberPackageId": 0
}'POST/api/v1/members/{memberId}/subscriptions/{id}/subscription-action-help-text
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredapplication/jsonlanguageLANGUAGEOptional"en", "no", "sv", "da"autoRenewbooleanOptionalisRestartbooleanOptional{
"language": "en",
"autoRenew": true,
"isRestart": true
}helpTextstringRequired{
"helpText": "string"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/{id}/subscription-action-help-text' \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"language": "en",
"autoRenew": true,
"isRestart": true
}'PATCH/api/v1/members/{memberId}/subscriptions/{id}/cancel
Cancels the pending Vipps charge if there is one, then stops the subscription immediately (active → stopped). A charge Vipps will no longer cancel does not block the stop; the response says whether one was cancelled.
Authentication: Bearer token (JWT)
memberIdstringRequiredidnumberRequiredpendingChargeCancelledbooleanRequired{
"pendingChargeCancelled": true
}unauthorized
This response has no body.
forbiddenResource
Same fields as Get all subscriptions of a member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
messageCodestringRequired"notFound"messagestringerrorsarray of FieldErrorRequired7 fieldserrorsfieldstringRequired when parent is presentField path: errors[].fieldfieldValuestringRequired when parent is presentField path: errors[].fieldValueidentifierstringRequired when parent is presentField path: errors[].identifieridentifierValuestringRequired when parent is presentField path: errors[].identifierValuemessageCodestringRequired when parent is presentField path: errors[].messageCodemessagestringField path: errors[].messageerrorTypestringRequired when parent is presentField path: errors[].errorType{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{memberId}/subscriptions/{id}/cancel' \
--request PATCH \
--header 'Authorization: Bearer <token>'