PATCH v3/baskets/{id}/membership-subscriptions

Amend the details of a number of memberships in a basket

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

Required

subscriptionIds

Collection of string

None.

Body Parameters

MembershipSubscriptionPatch
NameDescriptionTypeAdditional information
AutoRenew

boolean

None.

OverriddenPrice

decimal number

None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json

Sample:
{
  "autoRenew": true
}

text/xml

Sample:

The response/request for text/xml format is no longer supported for this endpoint.

Response Information

Resource Description

Collection of MembershipSubscription
NameDescriptionTypeAdditional information
AutoRenew

boolean

None.

Membership

Membership

None.

StartDate

date

None.

ExpiryDate

date

None.

IsRenewal

boolean

None.

RelatedDonationId

string

None.

CustomItems

Collection of CustomItem

None.

Discount

The amount this item has been discounted by from any offers.

decimal number

None.

OriginalPrice

The original price of the item, before it was overridden.

decimal number

None.

Price

The nominal price of the item, before any commissions, discounts etc. have been applied.

decimal number

None.

PriceOverridden

If true, the nominal price of the item (before commissions, discounts etc.) has been overridden. Price contains the overridden price; OriginalPrice contains the price before it was overridden

boolean

None.

Total

The total price of the item after any commissions, discounts etc. have been applied.

decimal number

None.

Id

string

None.

Response Formats

application/json, text/xml

Sample:

Sample not available.