Skip to main content

Subscriptions

EntityActivityActivity.Subscription

Subscriptions represent recurring service agreements in your CRM. They track ongoing contracts with customers, including recurring revenue and billing cycles.

Use the Activity_Subscription endpoint to manage subscriptions. Subscriptions inherit all fields from Activity.

Endpoints

List Subscriptions

GET/v1/odata/Activity_Subscription

Single Subscription

GET/v1/odata/Activity_Subscription({id})

Create Subscription

POST/v1/odata/Activity_Subscription

Update Subscription

PUT/v1/odata/Activity_Subscription({id})

Delete Subscription

DELETE/v1/odata/Activity_Subscription({id})

Fields

Inherited Fields (from Activity)

See Activity Fields for all inherited fields.

Relationships

RelationshipTarget EntityCardinalityDescription
RelationshipRelationshipN:1Linked relation (customer)
ContactRelation.Person.ContactN:1Contact person
ProductLinesProductLine1:NProduct lines / line items
PhaseDatastore.Phase.ActivitySubscriptionN:1Subscription phase
LinkedActivitiesActivity1:NLinked activities

Expanding Relationships

GET/v1/odata/Activity_Subscription({id})?$expand=Relationship
GET/v1/odata/Activity_Subscription({id})/Relationship

Filtering Examples

GET/v1/odata/Activity_Subscription?$filter=contains(Subject, '{Subject}')&$top={top}
GET/v1/odata/Activity_Subscription?$filter=IsClosed eq {IsClosed}&$top={top}
GET/v1/odata/Activity_Subscription?$filter=Amount gt {Amount}&$top={top}
GET/v1/odata/Activity_Subscription?$filter=CreationDate gt {CreationDate}&$top={top}