subscription.md

Subscription

Structure

Subscription

Fields

Name	Type	Tags	Description
Id	*int	Optional	The subscription unique id within Chargify.
State	*models.SubscriptionState	Optional	The state of a subscription. * Live States * active - A normal, active subscription. It is not in a trial and is paid and up to date. * assessing - An internal (transient) state that indicates a subscription is in the middle of periodic assessment. Do not base any access decisions in your app on this state, as it may not always be exposed. * pending - An internal (transient) state that indicates a subscription is in the creation process. Do not base any access decisions in your app on this state, as it may not always be exposed. * trialing - A subscription in trialing state has a valid trial subscription. This type of subscription may transition to active once payment is received when the trial has ended. Otherwise, it may go to a Problem or End of Life state. * paused - An internal state that indicates that your account with Advanced Billing is in arrears. * Problem States * past_due - Indicates that the most recent payment has failed, and payment is past due for this subscription. If you have enabled our automated dunning, this subscription will be in the dunning process (additional status and callbacks from the dunning process will be available in the future). If you are handling dunning and payment updates yourself, you will want to use this state to initiate a payment update from your customers. * soft_failure - Indicates that normal assessment/processing of the subscription has failed for a reason that cannot be fixed by the Customer. For example, a Soft Fail may result from a timeout at the gateway or incorrect credentials on your part. The subscriptions should be retried automatically. An interface is being built for you to review problems resulting from these events to take manual action when needed. * unpaid - Indicates an unpaid subscription. A subscription is marked unpaid if the retry period expires and you have configured your Dunning settings to have a Final Action of mark the subscription unpaid. * End of Life States * canceled - Indicates a canceled subscription. This may happen at your request (via the API or the web interface) or due to the expiration of the Dunning process without payment. See the Reactivation documentation for info on how to restart a canceled subscription. While a subscription is canceled, its period will not advance, it will not accrue any new charges, and Advanced Billing will not attempt to collect the overdue balance. * expired - Indicates a subscription that has expired due to running its normal life cycle. Some products may be configured to have an expiration period. An expired subscription then is one that stayed active until it fulfilled its full period. * failed_to_create - Indicates that signup has failed. (You may see this state in a signup_failure webhook.) * on_hold - Indicates that a subscription’s billing has been temporarily stopped. While it is expected that the subscription will resume and return to active status, this is still treated as an “End of Life” state because the customer is not paying for services during this time. * suspended - Indicates that a prepaid subscription has used up all their prepayment balance. If a prepayment is applied, it will return to an active state. * trial_ended - A subscription in a trial_ended state is a subscription that completed a no-obligation trial and did not have a card on file at the expiration of the trial period. See Product Pricing – No Obligation Trials for more details. See Subscription States for more info about subscription states and state transitions.
BalanceInCents	*int64	Optional	Gives the current outstanding subscription balance in the number of cents.
TotalRevenueInCents	*int64	Optional	Gives the total revenue from the subscription in the number of cents.
ProductPriceInCents	*int64	Optional	(Added Nov 5 2013) The recurring amount of the product (and version),currently subscribed. NOTE: this may differ from the current price of,the product, if you’ve changed the price of the product but haven’t,moved this subscription to a newer version.
ProductVersionNumber	*int	Optional	The version of the product for the subscription. Note that this is a deprecated field kept for backwards-compatibility.
CurrentPeriodEndsAt	models.Optional[time.Time]	Optional	Timestamp relating to the end of the current (recurring) period (i.e.,when the next regularly scheduled attempted charge will occur)
NextAssessmentAt	models.Optional[time.Time]	Optional	Timestamp that indicates when capture of payment will be tried or,retried. This value will usually track the current_period_ends_at, but,will diverge if a renewal payment fails and must be retried. In that,case, the current_period_ends_at will advance to the end of the next,period (time doesn’t stop because a payment was missed) but the,next_assessment_at will be scheduled for the auto-retry time (i.e. 24,hours in the future, in some cases)
TrialStartedAt	models.Optional[time.Time]	Optional	Timestamp for when the trial period (if any) began
TrialEndedAt	models.Optional[time.Time]	Optional	Timestamp for when the trial period (if any) ended
ActivatedAt	models.Optional[time.Time]	Optional	Timestamp for when the subscription began (i.e. when it came out of trial, or when it began in the case of no trial)
ExpiresAt	models.Optional[time.Time]	Optional	Timestamp giving the expiration date of this subscription (if any)
CreatedAt	*time.Time	Optional	The creation date for this subscription
UpdatedAt	*time.Time	Optional	The date of last update for this subscription
CancellationMessage	models.Optional[string]	Optional	Seller-provided reason for, or note about, the cancellation.
CancellationMethod	models.Optional[models.CancellationMethod]	Optional	The process used to cancel the subscription, if the subscription has been canceled. It is nil if the subscription's state is not canceled.
CancelAtEndOfPeriod	models.Optional[bool]	Optional	Whether or not the subscription will (or has) canceled at the end of the period.
CanceledAt	models.Optional[time.Time]	Optional	The timestamp of the most recent cancellation
CurrentPeriodStartedAt	models.Optional[time.Time]	Optional	Timestamp relating to the start of the current (recurring) period
PreviousState	*models.SubscriptionState	Optional	Only valid for webhook payloads The previous state for webhooks that have indicated a change in state. For normal API calls, this will always be the same as the state (current state)
SignupPaymentId	*int	Optional	The ID of the transaction that generated the revenue
SignupRevenue	*string	Optional	The revenue, formatted as a string of decimal separated dollars and,cents, from the subscription signup ($50.00 would be formatted as,50.00)
DelayedCancelAt	models.Optional[time.Time]	Optional	Timestamp for when the subscription is currently set to cancel.
CouponCode	models.Optional[string]	Optional	(deprecated) The coupon code of the single coupon currently applied to the subscription. See coupon_codes instead as subscriptions can now have more than one coupon.
SnapDay	models.Optional[string]	Optional	The day of the month that the subscription will charge according to calendar billing rules, if used.
PaymentCollectionMethod	*models.CollectionMethod	Optional	The type of payment collection to be used in the subscription. For legacy Statements Architecture valid options are - invoice, automatic. For current Relationship Invoicing Architecture valid options are - remittance, automatic, prepaid.
Customer	*models.Customer	Optional	-
Product	*models.Product	Optional	-
CreditCard	*models.CreditCardPaymentProfile	Optional	-
Group	models.Optional[models.NestedSubscriptionGroup]	Optional	-
BankAccount	*models.BankAccountPaymentProfile	Optional	-
PaymentType	models.Optional[string]	Optional	The payment profile type for the active profile on file.
ReferralCode	models.Optional[string]	Optional	The subscription's unique code that can be given to referrals.
NextProductId	models.Optional[int]	Optional	If a delayed product change is scheduled, the ID of the product that the subscription will be changed to at the next renewal.
NextProductHandle	models.Optional[string]	Optional	If a delayed product change is scheduled, the handle of the product that the subscription will be changed to at the next renewal.
CouponUseCount	models.Optional[int]	Optional	(deprecated) How many times the subscription's single coupon has been used. This field has no replacement for multiple coupons.
CouponUsesAllowed	models.Optional[int]	Optional	(deprecated) How many times the subscription's single coupon may be used. This field has no replacement for multiple coupons.
ReasonCode	models.Optional[string]	Optional	If the subscription is canceled, this is their churn code.
AutomaticallyResumeAt	models.Optional[time.Time]	Optional	The date the subscription is scheduled to automatically resume from the on_hold state.
CouponCodes	[]string	Optional	An array for all the coupons attached to the subscription.
OfferId	models.Optional[int]	Optional	The ID of the offer associated with the subscription.
PayerId	models.Optional[int]	Optional	On Relationship Invoicing, the ID of the individual paying for the subscription. Defaults to the Customer ID unless the 'Customer Hierarchies & WhoPays' feature is enabled.
CurrentBillingAmountInCents	*int64	Optional	The balance in cents plus the estimated renewal amount in cents. Returned ONLY for readSubscription operation as it's compute intensive operation.
ProductPricePointId	*int	Optional	The product price point currently subscribed to.
ProductPricePointType	*models.PricePointType	Optional	Price point type. We expose the following types: 1. default: a price point that is marked as a default price for a certain product. 2. custom: a custom price point. 3. catalog: a price point that is not marked as a default price for a certain product and is not a custom one.
NextProductPricePointId	models.Optional[int]	Optional	If a delayed product change is scheduled, the ID of the product price point that the subscription will be changed to at the next renewal.
NetTerms	models.Optional[int]	Optional	On Relationship Invoicing, the number of days before a renewal invoice is due.
StoredCredentialTransactionId	models.Optional[int]	Optional	For European sites subject to PSD2 and using 3D Secure, this can be used to reference a previous transaction for the customer. This will ensure the card will be charged successfully at renewal.
Reference	models.Optional[string]	Optional	The reference value (provided by your app) for the subscription itelf.
OnHoldAt	models.Optional[time.Time]	Optional	The timestamp of the most recent on hold action.
PrepaidDunning	*bool	Optional	Boolean representing whether the subscription is prepaid and currently in dunning. Only returned for Relationship Invoicing sites with the feature enabled
Coupons	[]models.SubscriptionIncludedCoupon	Optional	Additional coupon data. To use this data you also have to include the following param in the requestinclude[]=coupons. Only in Read Subscription Endpoint.
DunningCommunicationDelayEnabled	*bool	Optional	Enable Communication Delay feature, making sure no communication (email or SMS) is sent to the Customer between 9PM and 8AM in time zone set by the dunning_communication_delay_time_zone attribute.
DunningCommunicationDelayTimeZone	models.Optional[string]	Optional	Time zone for the Dunning Communication Delay feature.
ReceivesInvoiceEmails	models.Optional[bool]	Optional	-
Locale	models.Optional[string]	Optional	-
Currency	*string	Optional	-
ScheduledCancellationAt	models.Optional[time.Time]	Optional	-
CreditBalanceInCents	*int64	Optional	-
PrepaymentBalanceInCents	*int64	Optional	-
PrepaidConfiguration	models.Optional[models.PrepaidConfiguration]	Optional	-
SelfServicePageToken	*string	Optional	Returned only for list/read Subscription operation when include[]=self_service_page_token parameter is provided.

Example (as JSON)

{
  "credit_card": {
    "id": 10088716,
    "first_name": "Test",
    "last_name": "Subscription",
    "masked_card_number": "XXXX-XXXX-XXXX-1",
    "card_type": "bogus",
    "expiration_month": 1,
    "expiration_year": 2022,
    "customer_id": 14543792,
    "current_vault": "bogus",
    "vault_token": "1",
    "billing_address": "123 Montana Way",
    "billing_city": "Billings",
    "billing_state": "MT",
    "billing_zip": "59101",
    "billing_country": "US",
    "customer_vault_token": null,
    "billing_address_2": "",
    "payment_type": "credit_card",
    "site_gateway_setting_id": 1,
    "gateway_handle": null
  },
  "dunning_communication_delay_time_zone": "\"Eastern Time (US & Canada)\"",
  "id": 96,
  "state": "soft_failure",
  "balance_in_cents": 212,
  "total_revenue_in_cents": 136,
  "product_price_in_cents": 70
}