Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

child?: Core.Graph
curie: "fx:subscription"
links: { fx:attributes: Backend.Rels.Attributes; fx:customer: Customer; fx:last_transaction: Backend.Rels.LastTransaction; fx:store: Backend.Rels.Store; fx:sub_modification_url: SubModificationUrl; fx:sub_token_url: Backend.Rels.SubTokenUrl; fx:transaction_template: Backend.Rels.TransactionTemplate; fx:transactions: Backend.Rels.Transactions; self: Backend.Rels.Subscription }

Type declaration

props: { date_created: null | string; date_modified: null | string; end_date: null | string; error_message: string; first_failed_transaction_date: null | string; frequency: string; is_active: boolean; next_transaction_date: string; past_due_amount: number; start_date: string; third_party_id: string }

Type declaration

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • end_date: null | string

    If set, the date this subscription will end. The subscription will not run on this day.

  • error_message: string

    If the last run of this subscription encountered an error, that error message will be saved here. It will also note if a past due payment was made.

  • first_failed_transaction_date: null | string

    If this subscription failed to process due to an error such as expired payment card, this field will show the first date the subscription failed to process. If it processes successfully at the next attempt, this field will be cleared.

  • frequency: string

    This determines how often this subscription will be processed. The format is a number followed by a date type such as d (day), w (week), m (month), or y (year). You can also use .5m for twice a month.

  • is_active: boolean

    Determines whether or not this transaction is active or not. If you are using the subscription datafeed, it is best to set the end_date to tomorrow instead of settings this to inactive.

  • next_transaction_date: string

    The date for when this subscription will run again.

  • past_due_amount: number

    If a subscription payment is missed, this amount will be increased by that payment. The next time the subscription runs, it will be charged automatically, depending on your store's subscription settings.

  • start_date: string

    The original date this subscription began or will begin if set in the future.

  • third_party_id: string

    If this subscription is using a third party subscription system such as PayPal Express, their identifier will be set here.

zooms: { attributes: Backend.Rels.Attributes; customer?: Customer; last_transaction?: Backend.Rels.LastTransaction; original_transaction?: Backend.Rels.OriginalTransaction; transaction_template?: Backend.Rels.TransactionTemplate; transactions?: Backend.Rels.Transactions }

Type declaration

Generated using TypeDoc