Bulldog\Strype\Resources
Classes
This is an object representing your Stripe balance. You can retrieve it to see
the balance currently on your Stripe account.
To charge a credit or a debit card, you create a Charge object. You can retrieve
and refund individual charges as well as list all charges. Charges are identified
by a unique, random ID.
A coupon contains information about a percent-off or amount-off discount you
might want to apply to a customer. Coupons may be applied to invoices or orders.
Customer objects allow you to perform recurring charges, and to track multiple
charges, that are associated with the same customer. The API allows you to
create, delete, and update your customers. You can retrieve individual
customers as well as a list of all your customers.
A discount represents the actual application of a coupon to a particular customer.
A dispute occurs when a customer questions your charge with their card issuer.
Events are our way of letting you know when something interesting happens in
your account. When an interesting event occurs, we create a new Event object.
This is an object representing a file hosted on Stripe's servers. The file may
have been uploaded by yourself using the create file request (for example,
when uploading dispute evidence) or it may have been created by Stripe (for
example, the results of a Sigma scheduled query).
To share the contents of a File object with non-Stripe users, you can create
a FileLink. FileLinks contain a URL that can be used to retrieve the contents
of the file without authentication.
Invoices are statements of amounts owed by a customer, and are either generated
one-off, or generated periodically from a subscription.
Sometimes you want to add a charge or credit to a customer, but actually charge
or credit the customer's card only at the end of a regular billing cycle. This
is useful for combining several charges (to minimize per-transaction fees), or
for having Stripe tabulate your usage-based billing totals.
A PaymentIntent tracks the process of collecting a payment from your customer.
A Payout object is created when you receive funds from Stripe, or when you
initiate a payout to either a bank account or debit card of a connected
Stripe account. You can retrieve individual payouts, as well as list all
payouts. Payouts are made on varying schedules, depending on your country
and industry.
Plans define the base price, currency, and billing cycle for subscriptions.
Product objects describe items that your customers can subscribe to with a
Subscription. An associated Plan determines the product pricing.
Refund objects allow you to refund a charge that has previously been created
but not yet refunded. Funds will be refunded to the credit or debit card that
was originally charged.
Subscriptions allow you to charge a customer on a recurring basis. A subscription
ties a customer to a particular plan you've created.
Subscription items allow you to create customer subscriptions with more than
one plan, making it easy to represent complex billing relationships.
Tokenization is the process Stripe uses to collect sensitive card or bank account
details, or personally identifiable information (PII), directly from your customers
in a secure manner. A token representing this information is returned to your server
to use. You should use Checkout, Elements, or our mobile libraries to perform this
process, client-side. This ensures that no sensitive card data touches your server,
and allows your integration to operate in a PCI-compliant way.
Usage records allow you to report customer usage and metrics to Stripe for
metered billing of subscription plans.