< Back to home

HoldingSubscriptionDetails

The details of a holding subscription belonging to a contact or new contact.

Properties

Name Type Description Required
Id Int32 (Nullable) The Id of the Subscription in the main table. No
HoldingId Int32 (Nullable) The Id of the Subscription in the holding table. No
ContactId Int32 (Nullable) The Id of a Contact. This needs to be filled when adding a Subscription to an existing Contact. No
HoldingPersonalDetailsId Int32 (Nullable) The Id of the Personal Details in the holding table. No
SubscriptionClassId Int32 The Id of the Subscription Class. No
SubscriptionStatusId Int32 The Id of the Subscription Status. No
PaymentMethodId Int32 The Id of the Payment Method. No
Amount Decimal The cost of the Subscription - excluding any discounts. No
ToRemove Boolean Indicates if this particular Subscription should be removed from the Contact. No
DiscountRate Decimal (Nullable) The discount, in the form of a percentage, to be applied to the cost of the subscription. No
DiscountAmount Decimal (Nullable) The discount, in the form of an amount, to be applied to the cost of the subscription. No
DiscountUntil DateTime (Nullable) The date that the discount should apply to. No
StartDate DateTime (Nullable) The date the subscription starts. No
ExpirationDate DateTime (Nullable) The date the subscription should expire. The status will automatically change to 'Expired'. No
LastDueDate DateTime (Nullable) The date the subscription was last due. No
NextDueDate DateTime (Nullable) The date the subscription is next due. No
NextDemandDate DateTime (Nullable) The date a demand will next be created for this subscription. No
EndDate DateTime (Nullable) The date the subscription ends. No
PoliticalLevyAmount Decimal (Nullable) The political levy amount that should get added to the base cost of the subscription. No
Total Decimal The final cost of the Subscription - once any discounts have been applied. No
NewPayment HoldingPayment A payment that should be added for this subscription. No

Endpoints

Url Actions Description
api/holdingsubscriptiondetails/{id} GET Gets a single Subscription.
api/holdingsubscriptiondetails/contact/{contactId} GET Lists all Subscriptions for a contact.
api/holdingsubscriptiondetails POST Adds or updates a Subscription for an existing contact.