Orders | Subscriptions

Returns a single subscription

get/api/Subscriptions/{id}

Request

  • Base URL: https://api.omnium.no (the document declares no server; this is the origin it was published from)
  • URL: https://api.omnium.no/api/Subscriptions/{id}
  • Auth: API key in header Authorization

Path parameters

idstring required

ID of the subscription to return

Response

Success

idstring nullable

Unique subscription ID

customerIdstring nullable

The ID of the customer - should be an unique value

customerNumberstring nullable

The customer number

customerNamestring nullable

Name of customer

customerPhonestring nullable

Customer phone number with prefix. e.g. +4740000000

customerEmailstring nullable

Customer e-mail

startDatestring date-time nullable

Start date of the subscription

endDatestring date-time nullable

End date of the subscription

nextOrderDatestring date-time nullable

Date when next order should be created

subscriptionOrderCreationTimestring

Time of day when the subscription order should be created

intervalDaysinteger

Interval in days between each order

schedulestring nullable

Subscription schedule - Cron expression

statusstring required

Subscription current status

modifiedBystring nullable

User (or system) that last modified the entity

isAnonymizedboolean

Marked as anonymized s

modifiedstring date-time

Last time the subscription was updated

createdstring date-time

When the subscription was created

lastFailedVerificationAttemptstring date-time nullable

When subscription verification last failed

numberOfVerificationAttemptsinteger nullable

Number of failed verification attempts. Should be reset when a successful verification attempt

createPendingOrdersboolean

Create pending orders for subscription

numberOfPendingOrdersinteger nullable

Number of pending orders to create (Default: 3)

Changes

No recorded changes to this operation across all 1 revision of this API.