E-Invoice | Subrite

E-Invoice

Endpoints for E-Invoice

ReferenceUpdated October 13, 2026View as Markdown

POST/api/v1/e-invoice/subscribe

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Schema ExampleEInvoicePackageSubscriptionDto

application/json

{
  "packageId": 0,
  "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>"
  }
}

Example · 30 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Example requestcurl

curl

curl https://api.subrite.no/api/v1/e-invoice/subscribe \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "packageId": 0,
  "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>"
  }
}'

Try it

Send a real request to api.subrite.no from your browser. Your token is only kept in this tab, until you reload or close it.

POST https://api.subrite.no/api/v1/e-invoice/subscribe

Bearer token · Required

Request body (JSON)

POST/api/v1/e-invoice/subscribe-from-admin

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

Send recurring invoices to members#

POST/api/v1/e-invoice/send-recurring-invoices

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 201

This response has no body.

Responses 401

Status201 401 403 500application/json

GET/api/v1/e-invoice/orbyt/invoice-list/{memberId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

memberIdstringRequired

Responses

3 status codes

Responses 401

unauthorized

This response has no body.

Responses 403

GET/api/v1/e-invoice/orbyt/invoice-status/{kid}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

kidstringRequired

Responses

3 status codes

Responses 401

unauthorized

This response has no body.

Responses 403

GET/api/v1/e-invoice/renew-e-invoices

Authentication: Bearer token (JWT)

Parameters

Query parameters1

renewalDatestring (date-time)Optional

Responses

3 status codes

Responses 401

unauthorized

This response has no body.

Responses 403

Send existing invoice to member#

POST/api/v1/e-invoice/send-existing-invoice/{invoiceId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

invoiceIdnumberRequired

Responses

5 status codes

Responses 201

This response has no body.

GET/api/v1/e-invoice/usage

Authentication: Bearer token (JWT)

Responses

4 status codes

Responses 200

Status200 401 403 500application/json

Schema ExampleEInvoiceUsageResponseDto

2 top-level fieldsSelect an object to expand

monthlyarray of EInvoiceUsageMonthlyDtoRequired6 fields

manualPrice

number

"SE"

, "DK"

, "FI"

, "FO"

, "GB"

packagePackageRequiredField path: memberPackage.package35 fields

memberPackage.package

paymentProvidersarray of PAYMENT_PROVIDERRequiredField path: memberPackage.package.paymentProviders
Allowed values: "stripe", "vipps", "external", "nets", "efaktura-avtalegiro-ehf", "swedbankpay"
repeatPurchaseControlRepeatPurchaseControlRequiredField path: memberPackage.package.repeatPurchaseControl
Allowed values: "allow", "warning", "block_active", "block_forever", "cooldown"
repeatPurchaseCooldownDaysnumberField path: memberPackage.package.repeatPurchaseCooldownDays
Can be null
displayOrdernumberField path: memberPackage.package.displayOrder
Can be null
seoSeoField path: memberPackage.package.seo
Can be null
Nested fields omitted: depth limit.
salesTitlestringRequiredField path: memberPackage.package.salesTitle
uuidstringRequiredField path: memberPackage.package.uuid
subscriptionPlanIdnumberRequiredField path: memberPackage.package.subscriptionPlanId
slugstringRequiredField path: memberPackage.package.slug
imagestringRequiredField path: memberPackage.package.image
namestringRequiredField path: memberPackage.package.name
descriptionobjectRequiredField path: memberPackage.package.description
billingPeriodstringRequiredField path: memberPackage.package.billingPeriod
Allowed values: "monthly", "thirty_days", "quarterly", "half_yearly", "yearly", "custom"
billingPeriodUnitstringRequiredField path: memberPackage.package.billingPeriodUnit
Allowed values: "day", "week", "month", "year"
billingPeriodFrequencynumberRequiredField path: memberPackage.package.billingPeriodFrequency
statusstringRequiredField path: memberPackage.package.status
Allowed values: "draft", "published", "archived"
isAvailableOnMyPagebooleanRequiredField path: memberPackage.package.isAvailableOnMyPage
isAvailableViaSlugbooleanRequiredField path: memberPackage.package.isAvailableViaSlug
isAvailableForManualOrderViaAdminbooleanRequiredField path: memberPackage.package.isAvailableForManualOrderViaAdmin
allowSameSubscriptionChangebooleanRequiredField path: memberPackage.package.allowSameSubscriptionChange
allowDifferentSubscriptionSwitchbooleanRequiredField path: memberPackage.package.allowDifferentSubscriptionSwitch
tenantIdnumberRequiredField path: memberPackage.package.tenantId
onboardingWelcomeRedirectCTATextTranslationRequiredField path: memberPackage.package.onboardingWelcomeRedirectCTATextNested fields omitted: depth limit.
customPeriodTextTranslationRequiredField path: memberPackage.package.customPeriodTextNested fields omitted: depth limit.
orderCtaLabelTranslationRequiredField path: memberPackage.package.orderCtaLabelNested fields omitted: depth limit.
introPeriodFixedEndDatestring (date-time)RequiredField path: memberPackage.package.introPeriodFixedEndDate
packageProductsarray of PackageProductRequiredField path: memberPackage.package.packageProductsNested fields omitted: depth limit.
subscriptionPlanSubscriptionPlanRequiredField path: memberPackage.package.subscriptionPlanNested fields omitted: depth limit.
paymentsarray of PaymentRequiredField path: memberPackage.package.paymentsNested fields omitted: depth limit.
memberPackagesarray of MemberPackageRequiredField path: memberPackage.package.memberPackagesRecursive schema; nested fields are not repeated.
idnumberRequiredField path: memberPackage.package.id
createdAtstring (date-time)RequiredField path: memberPackage.package.createdAt
updatedAtstring (date-time)RequiredField path: memberPackage.package.updatedAt
deletedAtstring (date-time)RequiredField path: memberPackage.package.deletedAt
metaDataobjectRequiredField path: memberPackage.package.metaData

Schema ExampleFakturaPaymentResponseDto

200 · application/json

{
  "checkoutStateUuid": "string",
  "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": {}
  },
  "invoiceNumber": 0
}

Example · 95 linesShow full heightShow compact view

Responses 401

Status200 400 401 403 500application/json

unauthorized

, "efaktura-avtalegiro-ehf"

, "swedbankpay"

Schema ExampleFakturaPackageSubscriptionDto

application/json

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

Example · 34 linesShow full heightShow compact view

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleFakturaPaymentResponseDto

200 · application/json

{
  "checkoutStateUuid": "string",
  "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": {}
  },
  "invoiceNumber": 0
}

Example · 95 linesShow full heightShow compact view

Responses 400

invalidPackage, badRequest

Responses 401

unauthorized

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Responses 500

Status200 400 401 403 500application/json

internalServerError

Example requestcurl

curl

curl https://api.subrite.no/api/v1/e-invoice/subscribe-from-admin \
  --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>"
  }
}'

Schema ExampleErrorResponse

Same fields as Subscribe a package via invoice payment (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

Same fields as Subscribe a package via invoice payment (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

Same fields as Subscribe a package via invoice payment (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

application/json

Schema ExampleErrorResponse

Same fields as Subscribe a package via invoice payment (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

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

Schema ExampleErrorResponse

400 · application/json

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

Example · 7 linesShow full heightShow compact view

Responses 401

Status201 400 401 403 500application/json

unauthorized

Schema ExampleErrorResponse

Same fields as Subscribe a package via invoice payment (401).

Schema ExampleErrorResponse

401 · application/json

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

Example · 7 linesShow full heightShow compact view

Schema ExampleEInvoiceUsageResponseDto

200 · application/json

{
  "monthly": [
    {}
  ],
  "total": {
    "sent_via_einvoice": 0,
    "sent_via_email": 0,
    "sent_via_sms": 0,
    "sent_manually": 0,
    "total_sent": 0
  }
}

Example · 12 linesShow full heightShow compact view

Responses 403

Status200 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Subscribe a package via invoice payment (401).

Schema ExampleErrorResponse

403 · application/json

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

Example · 7 linesShow full heightShow compact view

Subscribe a package via invoice payment#

Request body

Responses

Responses 200

Subscribe a package via invoice payment from admin#

Request body

Send recurring invoices to members#

Responses

Responses 201

Responses 401

Get submitted invoices from Orbyt#

Parameters

Responses

Responses 401

Responses 403

Get invoice status from Orbyt#

Parameters

Responses

Responses 401

Responses 403

Renew e-invoices#

Parameters

Responses

Responses 401

Responses 403

Send existing invoice to member#

Parameters

Responses

Responses 201

Get usage of e-invoices#

Responses

Responses 200

Subscribe a package via invoice payment#

Request body

Responses

Responses 200

Subscribe a package via invoice payment from admin#

Request body

Send recurring invoices to members#

Responses

Responses 201

Responses 401

Get submitted invoices from Orbyt#

Parameters

Responses

Responses 401

Responses 403

Get invoice status from Orbyt#

Parameters

Responses

Responses 401

Responses 403

Renew e-invoices#

Parameters

Responses

Responses 401

Responses 403

Send existing invoice to member#

Parameters

Responses

Responses 201

Get usage of e-invoices#

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Responses 403

Responses 500

Responses 500

Responses 500

Responses 500

Responses 400