Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /voss/subscriptions | PUT voss subscription |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | body | Guid | No | The company id. Subscription will be fetched of this company |
DiscountAgreements | body | List<SubscriptionDiscountAgreementRequestDto> | No | Discount agreement data |
DiscountAgreementsChangeType | body | DiscountAgreementsChangeTypeEnum | No | Discount agreements change type controls how already occured transactions are treated <br />Retrospective - all future and past not invoiced transactions will be recalculated with new discount agreements <br />Prospective - discounts will apply only for future transactions |
CompanyOwnerId | body | int | No | The company id. Subscription will be fetched of this company |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DiscountAgreementId | form | Guid | No | |
Period | form | SubscriptionDiscountPeriodRequestDto | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PeriodKind | form | PeriodKindEnum | No | |
Length | form | DiscountAgreementTimeLengthRequestDto | Yes | |
PeriodIterationCount | form | int? | No |
FixedTime | |
AlignedToBindingPeriod | |
AlignedToSubscriptionBillingPeriod |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Unit | form | UnitEnum | No | |
Value | form | int | No |
Day | |
Month | |
Year |
Prospective | |
Retrospective |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /voss/subscriptions HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length
{"DiscountAgreements":[{}],"DiscountAgreementsChangeType":"Prospective","CompanyOwnerId":0}
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {}