Member
Endpoints for Member
ReferenceView as Markdown
Endpoints for Member
POST/api/v1/members
Authentication: Bearer token (JWT)
application/jsonfullNamestringRequiredemailstring (email)RequiredbirthDatestring (date-time)RequirednickNamestringRequiredmaxLength: 255phonestringRequiredmaxLength: 32countryCodestringOptionalmaxLength: 8isCompanybooleanRequiredcompanyNamestringRequiredmaxLength: 255addressMemberAddressDtoRequired11 fieldsaddressline1stringOptionalField path: address.line1maxLength: 255line2stringOptionalField path: address.line2maxLength: 255citystringOptionalField path: address.citymaxLength: 255statestringOptionalField path: address.statemaxLength: 255customPropertyValuesobjectOptional{
"fullName": "<fullName>",
"email": "user@example.com",
"birthDate": "<birthDate>",
"nickName": "string",
"phone": "<phone>",
"countryCode": "string",
"isCompany": true,
"companyName": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
},
"customPropertyValues": {}
}idstringRequiredfullNamestringRequirednickNamestringRequiredcreatedAtstring (date-time)curlcurl https://api.subrite.no/api/v1/members \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"fullName": "<fullName>",
"email": "user@example.com",
"birthDate": "<birthDate>",
"nickName": "string",
"phone": "<phone>",
"countryCode": "string",
"isCompany": true,
"companyName": "string",
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
},
"customPropertyValues": {}
}'POST/api/v1/members/list
Authentication: Bearer token (JWT)
pagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderDirectionstringOptional"desc"Allowed values: "asc", "desc"orderBystringOptionalPOST/api/v1/members/filter
Authentication: Bearer token (JWT)
pagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderDirectionstringOptional"desc"Allowed values: "asc", "desc"orderBystringOptionalGET/api/v1/members/{id}
Authentication: Bearer token (JWT)
idstringRequiredlegacySupportbooleanOptionalDELETE/api/v1/members/{id}
Authentication: Bearer token (JWT)
idstringRequiredThis response has no body.
PATCH/api/v1/members/{id}
Authentication: Bearer token (JWT)
idstringRequiredlegacySupportbooleanOptionalapplication/jsonfullNameGET/api/v1/members/{id}/invoices
Authentication: Bearer token (JWT)
idstringRequiredGET/api/v1/members/search
Authentication: Bearer token (JWT)
querystringRequiredtakenumberOptional100minimum: 1maximum: 100GET/api/v1/members/enqueue-cleanup-s3-files
Authentication: Bearer token (JWT)
This response has no body.
unauthorized
GET/api/v1/members/by-member-number/{memberNumber}
Authentication: Bearer token (JWT)
memberNumberstringRequiredGET/api/v1/members/{id}/revenue
Authentication: Bearer token (JWT)
idstringRequireddatePeriodDATE_PERIODRequired"since_start", "last_3_years", "last_2_years", "last_1_year", "last_3_months"GET/api/v1/members/{id}/orders
Authentication: Bearer token (JWT)
idstringRequiredpagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptional"createdAt"Allowed values: "createdAt"GET/api/v1/members/{id}/payments
Authentication: Bearer token (JWT)
idstringRequiredpagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptional"createdAt"GET/api/v1/members/{id}/notes
Authentication: Bearer token (JWT)
idstringRequiredpagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptional"createdAt"Allowed values: "createdAt"GET/api/v1/members/{id}/communication-activities
Authentication: Bearer token (JWT)
idstringRequiredpagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderBystringOptionalGET/api/v1/members/{id}/consents
Authentication: Bearer token (JWT)
idstringRequiredGET/api/v1/members/{id}/consents/history/{consentId}
Authentication: Bearer token (JWT)
idstringRequiredconsentIdnumberRequiredpagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50PATCH/api/v1/members/{id}/consents/{consentId}
Authentication: Bearer token (JWT)
idstringRequiredconsentIdnumberRequiredapplication/jsonchannelstringGET/api/v1/members/{id}/settings
Authentication: Bearer token (JWT)
idstringRequiredPATCH/api/v1/members/{id}/settings
Authentication: Bearer token (JWT)
idstringRequiredapplication/jsonisTestUserbooleanOptionalfixedOTPstringPOST/api/v1/members/subscriptions/list
Authentication: Bearer token (JWT)
pagenumberOptional1minimum: 1takenumberOptional10minimum: 1maximum: 50orderDirectionstringOptional"desc"Allowed values: "asc", "desc"orderBystringOptionalpostCodestringOptionalField 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: 255avatarstringRequiredcountryCodestringbirthDatestring (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"
}
}shouldNotBeEmpty, mustBeAnEmail, mustBeADateInstance, invalidFormat, alreadyExists, phoneAlreadyVerified, unknownCustomProperty
messageCodestringRequired"shouldNotBeEmpty", "mustBeAnEmail", "mustBeADateInstance", "invalidFormat", "alreadyExists", "phoneAlreadyVerified", "unknownCustomProperty"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[].messageCodemessage{
"messageCode": "shouldNotBeEmpty",
"message": "string",
"errors": [
{}
]
}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": [
{}
]
}"email", "createdAt", "id", "updatedAt", "totalRevenue"application/jsonfiltersarray of MemberFilterRequired3 required when the containing object is present3 fieldsfiltersfieldMEMBER_FILTER_FIELDRequired when parent is presentField path: filters[].field"email", "id", "userId", "updatedAt", "subscriptionStatus", "subscriptionPlanId", "customProperty", "postCode", "phone", "name", "isCompany", "type", "consent", "inactivity", "emailStatus", "search"operatorMEMBER_FILTER_OPERATORRequired when parent is presentField path: filters[].operator"eq", "neq", "gt", "gte", "lt", "lte", "contains", "between"valueobjectRequired when parent is presentField path: filters[].valueitemsarray of MemberListDataRequired12 fieldsitemsmemberIdstringRequired when parent is presentField path: items[].memberIdmemberNumbernumberRequired when parent is presentField path: items[].memberNumberuserIdnumberRequired when parent is presentField path: items[].userIdfullNamestringRequired when parent is presentField path: items[].fullNameisCompanybooleanRequired when parent is presentField path: items[].isCompanycompanyNamestringRequired when parent is presentField path: items[].companyNameemailstringRequired when parent is presentField path: items[].emailphonestringRequired when parent is presentField path: items[].phonecreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtmemberEmailStatusSendgridEmailActivityStatusRequired when parent is presentField path: items[].memberEmailStatus"scheduled", "processed", "dropped", "deferred", "bounce", "hard_bounce", "soft_bounce", "spamreport", "delivered", "unsubscribe", "group_unsubscribe", "group_resubscribe", "open", "failed", "click", "skipped_bounced"totalRevenuenumberRequired when parent is presentField path: items[].totalRevenuehasActiveSubscriptionbooleanRequired when parent is presentField path: items[].hasActiveSubscriptionmetaPageMetaRequired6 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
}
}This response has no body.
shouldNotBeEmpty, invalidFormat, memberFilterFieldUnsupported
messageCodestringRequired"shouldNotBeEmpty", "invalidFormat", "memberFilterFieldUnsupported"messagestringunauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/members/list \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filters": [
{
"value": {}
}
]
}'"email", "createdAt", "id", "updatedAt", "totalRevenue"legacySupportbooleanOptionalA custom-property filter is sent as field: "customProperty.<propertyName>". That dotted form is applied by this endpoint only; POST /members/list rejects it.
application/jsonitemsarray of MemberPersonalInfoRequired20 fieldsitemsidstringRequired when parent is presentField path: items[].idfullNamestringRequired when parent is presentField path: items[].fullNamenickNamestringRequired when parent is presentField path: items[].nickNamecreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtavatarstringRequired when parent is presentField path: items[].avatarcountryCodestringField path: items[].countryCodebirthDatestring (date-time)Required when parent is presentField path: items[].birthDatedeleteAfterExpirationbooleanRequired when parent is presentField path: items[].deleteAfterExpirationisCompanybooleanRequired when parent is presentField path: items[].isCompanycompanyNamestringRequired when parent is presentField path: items[].companyNameorganizationNostringRequired when parent is presentField path: items[].organizationNocustomPropertyValuesobjectRequired when parent is presentField path: items[].customPropertyValuesemailVerifiedstringField path: items[].emailVerifiedphoneVerifiedbooleanRequired when parent is presentField path: items[].phoneVerifiedmemberNumbernumberRequired when parent is presentField path: items[].memberNumberuserIdnumberRequired when parent is presentField path: items[].userIdemailStatusSENDGRID_MAIL_EVENTSField path: items[].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[].emailphonestringRequired when parent is presentField path: items[].phoneaddressProfileAddressRequired when parent is presentField path: items[].address12 fieldsitems[].addressline1stringRequired when parent is presentField path: items[].address.line1line2stringRequired when parent is presentField path: items[].address.line2citystringRequired when parent is presentField path: items[].address.citypostCodestringRequired when parent is presentField path: items[].address.postCodecountrystringRequired when parent is presentField path: items[].address.countrymetaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{
"customPropertyValues": {}
}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}This response has no body.
shouldNotBeEmpty, invalidFormat, memberFilterFieldUnsupported
{
"messageCode": "shouldNotBeEmpty",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/members/filter \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filters": [
{
"value": {}
}
]
}'MemberPersonalInfoSame fields as Create a new member (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"
}
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new 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 present{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}' \
--header 'Authorization: Bearer <token>'application/jsonhasActiveSubscriptions, hasOpenInvoices
messageCodestringRequired"hasActiveSubscriptions", "hasOpenInvoices"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": "hasActiveSubscriptions",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
Same fields as Get a member by id (404).
{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}' \
--request DELETE \
--header 'Authorization: Bearer <token>'stringdeleteAfterExpirationbooleanOptionaladdressMemberAddressDtoOptional11 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: 255emailstring (email)OptionalbirthDatestring (date-time)OptionalnickNamestringOptionalmaxLength: 255phonestringOptionalmaxLength: 32countryCodestringOptionalmaxLength: 8isCompanybooleanOptionalcompanyNamestringOptionalmaxLength: 255customPropertyValuesobjectOptional{
"fullName": "<fullName>",
"deleteAfterExpiration": true,
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
},
"email": "user@example.com",
"birthDate": "<birthDate>",
"nickName": "string",
"phone": "<phone>",
"countryCode": "string",
"isCompany": true,
"companyName": "string",
"customPropertyValues": {}
}Same fields as Create a new member (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"
}
}shouldNotBeEmpty, mustBeAnEmail, mustBeADateInstance, invalidFormat, alreadyExists, phoneAlreadyVerified, unknownCustomProperty
Same fields as Create a new member (400).
{
"messageCode": "shouldNotBeEmpty",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
Same fields as Get a member by id (404).
{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"fullName": "<fullName>",
"deleteAfterExpiration": true,
"address": {
"line1": "string",
"line2": "string",
"city": "string",
"state": "string",
"postCode": "string",
"country": "string",
"name": "string",
"email": "user@example.com",
"organizationNo": "string",
"companyName": "string",
"invoiceReference": "string"
},
"email": "user@example.com",
"birthDate": "<birthDate>",
"nickName": "string",
"phone": "<phone>",
"countryCode": "string",
"isCompany": true,
"companyName": "string",
"customPropertyValues": {}
}'idnumberRequired when parent is presenttypeTransactionResponseTypeRequired when parent is present"payment", "refund", "invoice", "credit_note", "rounding_adjustment"invoiceNonumberRequired when parent is presentinvoiceDatestring (date-time)Required when parent is presentpackNamestringRequired when parent is presentmemberPackageIdnumberRequired when parent is presentmemberIdstringRequired when parent is presentmemberEmailstringRequired when parent is presentmemberNamestringtotalAmountnumberRequired when parent is presentstatusINVOICE_STATUSRequired when parent is present"paid", "unpaid", "over-due", "over-paid", "partially-paid", "refunded", "credited", "partially-credited"memberPackageStatusMEMBER_PACKAGE_STATUS"active", "inactive", "pending", "paused", "stopped", "expired", "waiting_for_activation"deliveryStatusINVOICE_DELIVERY_STATUS"sent_via_einvoice", "sent_via_email", "sent_via_sms", "sent_via_payment_gateway", "sent_manually", "in_progress", "not_sent"isCreditNotebooleanRequired when parent is presentreferencedInvoiceNumbernumberkidstringRequired when parent is presentnotestringRequired when parent is presentpaymentProviderPAYMENT_PROVIDERRequired when parent is present"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"memberNumbernumberRequired when parent is presentinvoiceDueDatestring (date-time)orderIdnumberRequired when parent is presentautoGeneratedbooleanRequired when parent is presentcreditNoteNumbersarray of number[
{
"id": 0,
"type": "payment",
"invoiceNo": 0,
"invoiceDate": "2019-08-24T14:15:22Z",
"packName": "string",
"memberPackageId": 0,
"memberId": "string",
"memberEmail": "string",
"memberName": "<memberName>",
"totalAmount": 0,
"status": "paid",
"memberPackageStatus": "active",
"deliveryStatus": "sent_via_einvoice",
"isCreditNote": true,
"referencedInvoiceNumber": 0,
"kid": "string",
"note": "string",
"paymentProvider": "stripe",
"memberNumber": 0,
"invoiceDueDate": "2019-08-24T14:15:22Z",
"orderId": 0,
"autoGenerated": true,
"creditNoteNumbers": []
}
]unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/invoices' \
--header 'Authorization: Bearer <token>'entityTypeobjectRequired when parent is presentidstringRequired when parent is presentfullNamestringRequired when parent is presentemailstringRequired when parent is presentcompanyNamestringRequired when parent is presentmemberNumbernumberRequired when parent is present[
{
"entityType": {},
"id": "string",
"fullName": "<fullName>",
"email": "string",
"companyName": "string",
"memberNumber": 0
}
]invalidFormat, searchQueryTooShort
messageCodestringRequired"invalidFormat", "searchQueryTooShort"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 present{
"messageCode": "invalidFormat",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/search?query=%3Cquery%3E' \
--header 'Authorization: Bearer <token>'This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl https://api.subrite.no/api/v1/members/enqueue-cleanup-s3-files \
--header 'Authorization: Bearer <token>'MemberPersonalInfoWithSubscriptionDaysidstringRequiredfullNamestringRequirednickNamestringRequiredcreatedAtstring (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"activeSubscriptionDaysnumberRequiredhasOwnSubscriptionbooleanRequiredemailstring (email)RequiredphonestringRequiredaddressProfileAddressRequired12 fieldsaddressline1stringRequiredField path: address.line1line2stringRequiredField path: address.line2citystringRequiredField path: address.citypostCodestringRequiredField path: address.postCodecountrystringRequiredField path: address.countrynamestringRequiredField path: address.name{
"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",
"activeSubscriptionDays": 0,
"hasOwnSubscription": true,
"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"
}
}memberNumberInvalid
messageCodestringRequired"memberNumberInvalid"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[].messageCode{
"messageCode": "memberNumberInvalid",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
Same fields as Get a member by id (404).
{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}Same fields as Get a member by member number (200).
curlcurl 'https://api.subrite.no/api/v1/members/by-member-number/{memberNumber}' \
--header 'Authorization: Bearer <token>'application/jsonsubscriptionRevenuenumberRequiredcustomOrderRevenuenumberRequiredtotalRevenuenumberRequiredsubscriptionRevenueAverageOfTenantnumberRequiredcustomOrderRevenueAverageOfTenantnumberRequiredtotalRevenueAverageOfTenantnumberRequiredsubscriptionRevenuePercentageDiffnumberRequiredcustomOrderRevenuePercentageDiffnumberRequiredtotalRevenuePercentageDiffnumberRequiredrefundedAmountnumberRequiredrefundedAmountAverageOfTenantnumberRequiredrefundedAmountPercentageDiffnumberRequired{
"subscriptionRevenue": 0,
"customOrderRevenue": 0,
"totalRevenue": 0,
"subscriptionRevenueAverageOfTenant": 0,
"customOrderRevenueAverageOfTenant": 0,
"totalRevenueAverageOfTenant": 0,
"subscriptionRevenuePercentageDiff": 0,
"customOrderRevenuePercentageDiff": 0,
"totalRevenuePercentageDiff": 0,
"refundedAmount": 0,
"refundedAmountAverageOfTenant": 0,
"refundedAmountPercentageDiff": 0
}invalidFormat
messageCodestringRequired"invalidFormat"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 present{
"messageCode": "invalidFormat",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
Same fields as Get a member by id (404).
{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/revenue?datePeriod=since_start' \
--header 'Authorization: Bearer <token>'"id""updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"itemsarray of OrderResponseRequired30 fieldsitemsidnumberRequired when parent is presentField path: items[].idorderDatestring (date-time)Required when parent is presentField path: items[].orderDateorderNumbernumberRequired when parent is presentField path: items[].orderNumberpaymentStatusPAYMENT_STATUSRequired when parent is presentField path: items[].paymentStatus"pending", "succeeded", "failed"amountnumberRequired when parent is presentField path: items[].amountcreditnumberRequired when parent is presentField path: items[].creditdebitnumberRequired when parent is presentField path: items[].debitpackageNamestringRequired when parent is presentField path: items[].packageNameplanNamestringRequired when parent is presentField path: items[].planNamepaymentProviderPAYMENT_PROVIDERRequired when parent is presentField path: items[].paymentProvider"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"currencystringRequired when parent is presentField path: items[].currencybillingPeriodInfoBillingPeriodInfoRequired when parent is presentField path: items[].billingPeriodInfo2 fieldsitems[].billingPeriodInfobillingPeriodstringRequired when parent is presentField path: items[].billingPeriodInfo.billingPeriodcustomBillingPeriodBillingPeriodDetailsRequired when parent is presentField path: items[].billingPeriodInfo.customBillingPeriodNested fields omitted: depth limit.allowedPaymentProvidersarray of PAYMENT_PROVIDERRequired when parent is presentField path: items[].allowedPaymentProviders"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"tenantIdnumberRequired when parent is presentField path: items[].tenantIdupgradeDataMemberPackageChangeDataField path: items[].upgradeData5 fieldsitems[].upgradeDataplanChangePlanChangeRequired when parent is presentField path: items[].upgradeData.planChangeNested fields omitted: depth limit.productChangearray of ProductChangeRequired when parent is presentField path: items[].upgradeData.productChangeNested fields omitted: depth limit.optionalProductsarray of OptionalProductWithQuantityRequired when parent is presentField path: items[].upgradeData.optionalProductsNested fields omitted: depth limit.planProductPricesarray of PlanProductPriceSnapshotField path: items[].upgradeData.planProductPricesmemberPackageIdnumberRequired when parent is presentField path: items[].memberPackageIdrecurringPriceAtOrdernumberRequired when parent is presentField path: items[].recurringPriceAtOrderpaymentIdnumberRequired when parent is presentField path: items[].paymentIdpaymentTokenstringRequired when parent is presentField path: items[].paymentTokentypestringRequired when parent is presentField path: items[].type"initial", "recurrent", "upgrade", "credit-note", "standalone"orderItemsarray of OrderItemRequired when parent is presentField path: items[].orderItems14 fieldsitems[].orderItemsorderIdnumberRequired when parent is presentField path: items[].orderItems[].orderIdproductIdnumberRequired when parent is presentField path: items[].orderItems[].productIdnamestringRequired when parent is presentField path: items[].orderItems[].namepricenumberRequired when parent is presentField path: items[].orderItems[].pricetaxnumberRequired when parent is presentpaymentPaymentRequired when parent is presentField path: items[].paymentNested fields omitted: field limit.memberPackageMemberPackageRequired when parent is presentField path: items[].memberPackageNested fields omitted: field limit.invoiceInvoiceRequired when parent is presentField path: items[].invoiceNested fields omitted: field limit.tenantTenantRequired when parent is presentField path: items[].tenantNested fields omitted: field limit.memberPackageChangeMemberPackageChangeRequired when parent is presentField path: items[].memberPackageChange12 fieldsitems[].memberPackageChangeisImmediatebooleanRequired when parent is presentField path: items[].memberPackageChange.isImmediatechangeInPricenumberRequired when parent is presentField path: items[].memberPackageChange.changeInPricestatusstringRequired when parent is presentField path: items[].memberPackageChange.status"CREATED", "PAYMENT_PENDING", "CONFIRMATION_PENDING_FOR_NEXT_RENEWAL", "PENDING_FOR_NEXT_RENEWAL", "COMPLETED", "CANCELLED"createdAtstring (date-time)Required when parent is presentField path: items[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: items[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: items[].deletedAtmetaDataobjectRequired when parent is presentField path: items[].metaDatametaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{
"allowedPaymentProviders": [],
"orderItems": [],
"metaData": {}
}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}invalidFormat
Same fields as Get revenue data of a member (400).
{
"messageCode": "invalidFormat",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/orders' \
--header 'Authorization: Bearer <token>'"createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"typestringOptional"payment", "refund", "invoice", "credit_note", "rounding_adjustment"itemsarray of PaymentAndRefundResponseRequired18 fieldsitemsidnumberRequired when parent is presentField path: items[].idtypeTransactionResponseTypeRequired when parent is presentField path: items[].type"payment", "refund", "invoice", "credit_note", "rounding_adjustment"paymentDatestring (date-time)Required when parent is presentField path: items[].paymentDateamountnumberRequired when parent is presentField path: items[].amountpaymentMethodstringRequired when parent is presentField path: items[].paymentMethod"card", "vipps", "manual_registration", "efaktura", "ehf", "avtalegiro"paymentProviderstringRequired when parent is presentField path: items[].paymentProvider"stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"memberPackageIdnumberRequired when parent is presentField path: items[].memberPackageIdpaymentReferencestringRequired when parent is presentField path: items[].paymentReferenceinvoiceNumbernumberRequired when parent is presentField path: items[].invoiceNumberinvoiceIdnumberRequired when parent is presentField path: items[].invoiceIdorderNumbernumberRequired when parent is presentField path: items[].orderNumberorderIdnumberRequired when parent is presentField path: items[].orderIdrefundNumbernumberField path: items[].refundNumberstatusstringRequired when parent is presentField path: items[].status"pending", "succeeded", "failed"notestringRequired when parent is presentField path: items[].notecreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: items[].updatedAtregistrationDatestring (date-time)Required when parent is presentField path: items[].registrationDatemetaPageMetaRequired6 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
}
}invalidFormat
Same fields as Get revenue data of a member (400).
{
"messageCode": "invalidFormat",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/payments' \
--header 'Authorization: Bearer <token>'"id""updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"itemsarray of NoteResponseRequired6 fieldsitemsidnumberRequired when parent is presentField path: items[].idnotestringRequired when parent is presentField path: items[].notememberIdstringRequired when parent is presentField path: items[].memberIdadminUserIdnumberRequired when parent is presentField path: items[].adminUserIdadminUserNamestringRequired when parent is presentField path: items[].adminUserNamecreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtmetaPageMetaRequired6 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
}
}invalidFormat
Same fields as Get revenue data of a member (400).
{
"messageCode": "invalidFormat",
"message": "string",
"errors": [
{}
]
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/notes' \
--header 'Authorization: Bearer <token>'"createdAt""createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"itemsarray of MemberCommunicationActivitiesResponseDtoRequired14 fieldsitemscommunicationChannelCOMMUNICATION_CHANNELRequired when parent is presentField path: items[].communicationChannel"sms", "email"statusSENDGRID_MAIL_EVENTSRequired when parent is presentField path: items[].status"scheduled", "processed", "dropped", "deferred", "bounce", "hard_bounce", "soft_bounce", "spamreport", "delivered", "unsubscribe", "group_unsubscribe", "group_resubscribe", "open", "failed", "click", "skipped_bounced"bounceClassificationstringField path: items[].bounceClassification"Invalid Address", "Technical", "Content", "Reputation", "Frequency or Volume Too High", "Mailbox Unavailable", "Unclassified"deliveredAtstring (date-time)Required when parent is presentField path: items[].deliveredAtfirstOpenedAtstring (date-time)Required when parent is presentField path: items[].firstOpenedAtmemberIdstringRequired when parent is presentField path: items[].memberIdlastUpdatedAtstring (date-time)Required when parent is presentField path: items[].lastUpdatedAtsubjectstringRequired when parent is presentField path: items[].subjectcreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtcommunicationIdnumberRequired when parent is presentField path: items[].communicationIdidnumberRequired when parent is presentField path: items[].idshowCommunicationDetailsbooleanRequired when parent is presentField path: items[].showCommunicationDetailsmessageIdstringField path: items[].messageIdrecipientstringField path: items[].recipientmetaPageMetaRequired6 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.
notFound, memberNotFound
messageCodestringRequired"notFound", "memberNotFound"messagestringcurlcurl 'https://api.subrite.no/api/v1/members/{id}/communication-activities' \
--header 'Authorization: Bearer <token>'idnumberRequired when parent is presentupdatedAtstring (date-time)Required when parent is presenttitlestringRequired when parent is presentdescriptionstringRequired when parent is presentimagestringRequired when parent is presentshowOnCheckoutPagebooleanRequired when parent is presentshowOnMyPagebooleanRequired when parent is presentstatusobjectRequired when parent is presentsortOrdernumberRequired when parent is presentfrequencystringRequired when parent is presentnewsletterProviderConfigIdnumberRequired when parent is presentconsentStatusstringRequired when parent is presentpurposestringRequired when parent is present"marketing_and_newsletter", "consent"visibilitystringRequired when parent is present"subscriber", "nonSubscriber", "all"[
{
"id": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"title": "string",
"description": "string",
"image": "string",
"showOnCheckoutPage": true,
"showOnMyPage": true,
"status": {},
"sortOrder": 0,
"frequency": "string",
"newsletterProviderConfigId": 0,
"consentStatus": "string",
"purpose": "marketing_and_newsletter",
"visibility": "subscriber"
}
]unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}memberNotFound
messageCodestringRequired"memberNotFound"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 present{
"messageCode": "memberNotFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/consents' \
--header 'Authorization: Bearer <token>'orderBystringOptional"createdAt"Allowed values: "createdAt", "id", "updatedAt"orderDirectionstringOptional"desc"Allowed values: "asc", "desc"itemsarray of ActivityLogResponseRequired6 fieldsitemsactionActivityLogActionRequired when parent is presentField path: items[].action"initial_purchase", "subscription_renewed", "auto_renewal_turned_off", "auto_renewal_turned_on", "subscription_expired", "payment_failed", "subscription_activated", "subscription_deactivated", "subscription_inactive", "subscription_reactivated", "subscription_stopped", "subscription_canceled_before_activation", "activation_date_updated", "next_renewal_updated", "recurring_price_updated", "change_initiated", "change_completed", "change_cancelled", "seat_invitation_sent", "seat_invitation_removed", "seat_invitation_accepted", "seat_member_added", "group_owner_access_enabled", "group_owner_access_disabled", "seat_gift_receiver_added", "seat_gift_receiver_removed", "seat_gift_receiver_accepted", "seat_gift_receiver_invitation_sent", "invoice_sent", "payment_method_updated", "payment_method_removed", "payment_provider_updated", "invoice_address_updated", "delivery_address_updated", "credit_note_created", "refund_registered", "payment_registered", "vipps_recurring_charge_initiated", "ledger_matched", "ledger_unmatched", "ledger_transaction_ignored", "update_member_profile", "update_consent", "login", "signup", "gdpr_deleted"feedobjectRequired when parent is presentField path: items[].feedcreatedAtstring (date-time)Required when parent is presentField path: items[].createdAtmemberIdstringRequired when parent is presentField path: items[].memberIdmemberNumbernumberRequired when parent is presentField path: items[].memberNumberidnumberRequired when parent is presentField path: items[].idmetaPageMetaRequired6 fieldsmetapagenumberRequiredField path: meta.pagetakenumberRequiredField path: meta.takecountnumberRequiredField path: meta.countpageCountnumberRequiredField path: meta.pageCounthasPreviousPagebooleanRequiredField path: meta.hasPreviousPagehasNextPagebooleanRequiredField path: meta.hasNextPage{
"items": [
{
"feed": {}
}
],
"meta": {
"page": 0,
"take": 0,
"count": 0,
"pageCount": 0,
"hasPreviousPage": true,
"hasNextPage": true
}
}badRequest, invalidFormat
messageCodestringRequired"badRequest", "invalidFormat"messagestringunauthorized
This response has no body.
curlcurl 'https://api.subrite.no/api/v1/members/{id}/consents/history/{consentId}' \
--header 'Authorization: Bearer <token>'"mypage", "onboarding", "newsletter", "admin", "mailchimp", "make", "m2m", "mailmojo", "import"referencestringOptionalnotestringRequiredmaxLength: 1000{
"channel": "mypage",
"reference": "string",
"note": "string"
}idnumberRequiredupdatedAtstring (date-time)RequiredtitlestringRequireddescriptionstringRequiredimagestringRequiredshowOnCheckoutPagebooleanRequiredshowOnMyPagebooleanRequiredstatusobjectRequiredsortOrdernumberRequiredfrequencystringRequirednewsletterProviderConfigIdnumberRequiredconsentStatusstringRequiredpurposestringRequired"marketing_and_newsletter", "consent"visibilitystringRequired"subscriber", "nonSubscriber", "all"{
"id": 0,
"updatedAt": "2019-08-24T14:15:22Z",
"title": "string",
"description": "string",
"image": "string",
"showOnCheckoutPage": true,
"showOnMyPage": true,
"status": {},
"sortOrder": 0,
"frequency": "string",
"newsletterProviderConfigId": 0,
"consentStatus": "string",
"purpose": "marketing_and_newsletter",
"visibility": "subscriber"
}badRequest, invalidFormat, invalidConsent, mailchimpBadRequest
messageCodestringRequired"badRequest", "invalidFormat", "invalidConsent", "mailchimpBadRequest"unauthorized
This response has no body.
notFound, memberNotFound
Same fields as Get all communication activities of a member (404).
newsletterProviderError
messageCodestringRequired"newsletterProviderError"messagestringcurlcurl 'https://api.subrite.no/api/v1/members/{id}/consents/{consentId}' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"channel": "mypage",
"reference": "string",
"note": "string"
}'idstringRequireduserTypestringRequiredisTestUserbooleanRequiredfixedOTPstringRequired{
"id": "string",
"userType": "string",
"isTestUser": true,
"fixedOTP": "<fixedOTP>"
}unauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
Same fields as Get a member by id (404).
{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/settings' \
--header 'Authorization: Bearer <token>'removeFromHardBounceListbooleanOptionalremoveFromSpamReportListbooleanOptional{
"isTestUser": true,
"fixedOTP": "<fixedOTP>",
"removeFromHardBounceList": true,
"removeFromSpamReportList": true
}Same fields as Get all settings of a member (200).
{
"id": "string",
"userType": "string",
"isTestUser": true,
"fixedOTP": "<fixedOTP>"
}adminUsersCantBeTestUsers, notAllowedToUpdateOwnTestUserSettings, invalidOtp, memberHasNoLoginAccount, invalidFormat
messageCodestringRequired"adminUsersCantBeTestUsers", "notAllowedToUpdateOwnTestUserSettings", "invalidOtp", "memberHasNoLoginAccount", "invalidFormat"messageunauthorized
This response has no body.
forbiddenResource
Same fields as Create a new member (403).
{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}notFound
Same fields as Get a member by id (404).
{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}curlcurl 'https://api.subrite.no/api/v1/members/{id}/settings' \
--request PATCH \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"isTestUser": true,
"fixedOTP": "<fixedOTP>",
"removeFromHardBounceList": true,
"removeFromSpamReportList": true
}'"id", "createdAt", "updatedAt", "status", "nextRenewal", "recurringPrice"application/jsonfiltersarray of MemberSubscriptionFilterRequired3 required when the containing object is present3 fieldsfiltersfieldMEMBER_SUBSCRIPTION_FILTER_FIELDRequired when parent is presentField path: filters[].field"subscriptionStatus", "autoRenew", "nextRenewal", "startedAt", "endedAt", "paymentProvider", "subscriptionPlanId", "packageId", "productId", "payerName", "payerEmail", "hasCustomPrice"operatorMEMBER_SUBSCRIPTION_FILTER_OPERATORRequired when parent is presentField path: filters[].operator"eq", "neq", "gt", "gte", "lt", "lte", "contains"valueobjectRequired when parent is presentField path: filters[].valueitemsarray of MemberSubscriptionListDataRequired16 fieldsitemsidnumberRequired when parent is presentField path: items[].idpayerstringRequired when parent is presentField path: items[].payermemberNumbernumberRequired when parent is presentField path: items[].memberNumbersubscriptionPlanstringRequired when parent is presentField path: items[].subscriptionPlanlastPaidAmountnumberRequired when parent is presentField path: items[].lastPaidAmountrecurringPricenumberRequired when parent is presentField path: items[].recurringPriceautoRenewbooleanRequired when parent is presentField path: items[].autoRenewhasCustomPricebooleanRequired when parent is presentField path: items[].hasCustomPriceactiveSubscriptionDaysnumberRequired when parent is presentField path: items[].activeSubscriptionDaysnextRenewalstring (date-time)Required when parent is presentField path: items[].nextRenewalpaymentProviderstringRequired when parent is presentField path: items[].paymentProviderstatusstringRequired when parent is presentField path: items[].statusscheduledActivationDatestring (date-time)Required when parent is presentField path: items[].scheduledActivationDatestartedAtstring (date-time)Required when parent is presentField path: items[].startedAtendedAtstring (date-time)Required when parent is presentField path: items[].endedAtendReasonSUBSCRIPTION_END_REASONRequired when parent is presentField path: items[].endReason"payment_failed", "expired", "stopped", "deactivated", "cancelled_before_activation", "cancelled"metaPageMetaRequired6 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
}
}This response has no body.
subscriptionFilterFieldUnsupported, subscriptionFilterOperatorUnsupported, subscriptionFilterValueInvalid, invalidSubscriptionStatus, shouldNotBeEmpty, invalidFormat
messageCodestringRequired"subscriptionFilterFieldUnsupported", "subscriptionFilterOperatorUnsupported", "subscriptionFilterValueInvalid", "invalidSubscriptionStatus", "shouldNotBeEmpty", unauthorized
This response has no body.
curlcurl https://api.subrite.no/api/v1/members/subscriptions/list \
--request POST \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"filters": [
{
"value": {}
}
]
}'stringerrorTypestringRequired when parent is presentField path: errors[].errorTypeerrorsarray 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": "shouldNotBeEmpty",
"message": "string",
"errors": [
{}
]
}namestringRequired when parent is presentField path: items[].address.nameemailstringRequired when parent is presentField path: items[].address.emailcompanyNamestringRequired when parent is presentField path: items[].address.companyNameorganizationNostringRequired when parent is presentField path: items[].address.organizationNoinvoiceReferencestringField path: items[].address.invoiceReferenceisSyncedbooleanField path: items[].address.isSyncedlastSyncedAtstring (date-time)Field path: items[].address.lastSyncedAtemailstringRequiredField path: address.emailcompanyNamestringRequiredField path: address.companyNameorganizationNostringRequiredField path: address.organizationNoinvoiceReferencestringField path: address.invoiceReferenceisSyncedbooleanField path: address.isSyncedlastSyncedAtstring (date-time)Field path: address.lastSyncedAtmessagestringerrorTypestringRequired when parent is presentField path: errors[].errorTypeseatTransferMaparray of SeatTransferMappingDtoField path: items[].upgradeData.seatTransferMapNested fields omitted: depth limit.quantitynumberRequired when parent is presentField path: items[].orderItems[].quantitynotestringRequired when parent is presentField path: items[].orderItems[].noteorderOrderRequired when parent is presentField path: items[].orderItems[].orderNested fields omitted: depth limit.productProductRequired when parent is presentField path: items[].orderItems[].productNested fields omitted: depth limit.idnumberRequired when parent is presentField path: items[].orderItems[].idcreatedAtstring (date-time)Required when parent is presentField path: items[].orderItems[].createdAtupdatedAtstring (date-time)Required when parent is presentField path: items[].orderItems[].updatedAtdeletedAtstring (date-time)Required when parent is presentField path: items[].orderItems[].deletedAtmetaDataobjectRequired when parent is presentField path: items[].orderItems[].metaDatadataMemberPackageChangeDataRequired when parent is presentupdatedBynumberRequired when parent is presentField path: items[].memberPackageChange.updatedBymemberPackageMemberPackageRequired when parent is presentField path: items[].memberPackageChange.memberPackageNested fields omitted: depth limit.orderOrderRequired when parent is presentField path: items[].memberPackageChange.orderNested fields omitted: depth limit.idnumberRequired when parent is presentField path: items[].memberPackageChange.idcreatedAtstring (date-time)Required when parent is presentField path: items[].memberPackageChange.createdAtupdatedAtstring (date-time)Required when parent is presentField path: items[].memberPackageChange.updatedAtdeletedAtstring (date-time)Required when parent is presentField path: items[].memberPackageChange.deletedAtmetaDataobjectRequired when parent is presentField path: items[].memberPackageChange.metaData{
"messageCode": "invalidFormat",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}errorsarray 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": [
{}
]
}errorsarray 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": "badRequest",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}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": "badRequest",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "notFound",
"message": "string",
"errors": [
{}
]
}errorsarray 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": "newsletterProviderError",
"message": "string",
"errors": [
{}
]
}stringerrorsarray 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": "adminUsersCantBeTestUsers",
"message": "string",
"errors": [
{}
]
}"invalidFormat"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": "subscriptionFilterFieldUnsupported",
"message": "string",
"errors": [
{}
]
}{
"messageCode": "string",
"message": "string",
"errors": [
{}
]
}