- API Documentation
- Overview
- Authentication
- Events
- Integration
- API Endpoints
- BillingAccounts
- Cards
- list
- Actions
- add
- delete
- deleteByNumber
- setPrimary
- Devices
- Fundraisers
- Invoices
- lookup
- Aspects
- adjustments
- invoiceTransactions
- transactions
- Actions
- collect
- Metros
- list
- Aspects
- summary
- topBusinesses
- topUsers
- Offers
- Payments
- Reports
- Subscriptions
- Users
- add
- alerts
- donateList
- donateLookup
- forgotPassword
- listOAuth
- lookup
- notificationSettings
- payments
- rewardList
- search
- signupWithCard
- Utilities
- categories
- extendedCategories
- features
- info
- locationSuggestions
- searchSuggestions
- searchSuggestionsMap
- Actions
- Venues
- Response Objects
- address
- alert
- application
- billingAccount
- businessStatsReport
- businessSummary
- card
- cashReward
- category
- chain
- collectionItem
- compactUser
- compactVenue
- device
- donation
- event
- fundraiser
- fundraiserSummary
- fundraiserUserTotal
- invoice
- invoiceAdjustment
- invoiceTransaction
- media
- merchantInfo
- metro
- offer
- offerDetails
- offerLink
- payable
- redemption
- results
- searchResults
- statsSummary
- subscription
- transaction
- transactionReport
- upgradeAction
- user
- userSegment
- userSummary
- userVenueTotal
- variableReward
- venue
Represents a subscription on a business.
Properties
id | The id of the subscription. |
startsOn |
The date the subscription starts.
This field may be null when there is no value or not applicable. |
endsOn |
The date that the subscription would end. When the subscription is being renewed if it is after the endsOn time it will be marked as EXPIRED and will not renew (no invoice will generate).
This field may be null when there is no value or not applicable. |
nextRenewal |
The date the subscription will next renew.
This field may be null when there is no value or not applicable. |
lastRenewal |
The date the subscription last rewewed.
This field may be null when there is no value or not applicable. |
state | The state of the subscription [ACTIVE, EXPIRED, PAST_DUE]. |