Class: Offer

Offer

An offer is a recurring plan which a user can subscribe to. You can create different offers with different plan attributes e.g. a monthly or a yearly based paid offer/plan.

new Offer()

Creates a new Offer. Generally you should never create a PAYMILL object on your own.
Source:

Extends

  • PaymillObject

Classes

Filter
Order

Members

amount :number

Every interval the specified amount will be charged. Only integer values are allowed (e.g. 42.00 = 4200).
Type:
  • number
Source:

app_id :string

App (ID) that created this offer or null if created by yourself.
Type:
  • string
Source:

created_at :Date

Unix-Timestamp for the creation date.
Type:
  • Date
Source:

currency :string

ISO 4217 formatted currency code
Type:
  • string
Source:

id :string

Unique identifier of this offer.
Type:
  • string
Source:

interval :Interval

Defining how often the client should be charged.
Type:
Source:

name :string

Your name for this offer
Type:
  • string
Source:

trial_period_days :number

Give it a try or charge directly?.
Type:
  • number
Source:

updated_at :Date

Unix-Timestamp for the last update.
Type:
  • Date
Source: