new Subscription()
Creates a new Subscription. Generally you should never create a PAYMILL object on your own.
- Source:
Extends
- PaymillObject
Classes
Members
-
<static> Status
-
Status of a subscription.
- Source:
Properties:
Name Type Description ACTIVE
string INACTIVE
string EXPIRED
string FAILED
string -
amount :number
-
The amount of the subscription in cents
Type:
- number
- Source:
-
app_id :string
-
App (ID) that created this subscription or null if created by yourself.
Type:
- string
- Source:
-
canceled_at :Date
-
Unix-Timestamp for the cancel date.
Type:
- Date
- Source:
-
client :Client
-
Corresponding client.
Type:
- Source:
-
created_at :Date
-
Unix-Timestamp for the creation date.
Type:
- Date
- Source:
-
currency :string
-
ISO 4217 formatted currency code
Type:
- string
- Source:
-
end_of_period :string|Interval
-
Expiring date of the subscription.
Type:
- string | Interval
- Source:
-
id :string
-
Unique identifier of this subscription.
Type:
- string
- Source:
-
interval :string|Interval
-
Defining how often the client should be charged
Type:
- string | Interval
- Source:
-
is_canceled :boolean
-
Subscription is marked as canceled or not.
Type:
- boolean
- Source:
-
is_deleted :boolean
-
Subscription is marked as deleted or not.
Type:
- boolean
- Source:
-
livemode :boolean
-
Whether this subscription was issued while being in live mode or not.
Type:
- boolean
- Source:
-
name :string
-
Name of the subscription
Type:
- string
- Source:
-
next_capture_at :Date
-
Unix-Timestamp for the next charge.
Type:
- Date
- Source:
-
offer :Offer
-
Corresponding offer.
Type:
- Source:
-
payment :Payment
-
Corresponding payment.
Type:
- Source:
-
period_of_validity :string|Interval
-
Limit the validity of the subscription.
Type:
- string | Interval
- Source:
-
status :string|Subscription.Status
-
Shows, if subscription is "active", "inactive", "expired" or "failed"
Type:
- string | Subscription.Status
- Source:
-
temp_amount :number
-
A one-time amount in cents, will charge once only
Type:
- number
- Source:
-
trial_end :Date
-
Unix-Timestamp for the trial period end.
Type:
- Date
- Source:
-
trial_start :Date
-
Unix-Timestamp for the trial period start
Type:
- Date
- Source:
-
updated_at :Date
-
Unix-Timestamp for the last update.
Type:
- Date
- Source: