-
Notifications
You must be signed in to change notification settings - Fork 461
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for the Checkout Session resource #740
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
// Package session provides API functions related to checkout sessions. | ||
package session | ||
|
||
import ( | ||
"net/http" | ||
|
||
stripe "github.com/stripe/stripe-go" | ||
) | ||
|
||
// Client is used to invoke /checkout_sessions APIs. | ||
type Client struct { | ||
B stripe.Backend | ||
Key string | ||
} | ||
|
||
// New creates a new session. | ||
func New(params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error) { | ||
return getC().New(params) | ||
} | ||
|
||
// New creates a new session. | ||
func (c Client) New(params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error) { | ||
session := &stripe.CheckoutSession{} | ||
err := c.B.Call(http.MethodPost, "/v1/checkout/sessions", c.Key, params, session) | ||
return session, err | ||
} | ||
|
||
// Get retrieves a session. | ||
func Get(id string, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error) { | ||
return getC().Get(id, params) | ||
} | ||
|
||
// Get retrieves a session. | ||
func (c Client) Get(id string, params *stripe.CheckoutSessionParams) (*stripe.CheckoutSession, error) { | ||
path := stripe.FormatURLPath("/v1/checkout/sessions/%s", id) | ||
session := &stripe.CheckoutSession{} | ||
err := c.B.Call(http.MethodGet, path, c.Key, params, session) | ||
return session, err | ||
} | ||
|
||
func getC() Client { | ||
return Client{stripe.GetBackend(stripe.APIBackend), stripe.Key} | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
package session | ||
|
||
import ( | ||
"testing" | ||
|
||
assert "github.com/stretchr/testify/require" | ||
stripe "github.com/stripe/stripe-go" | ||
_ "github.com/stripe/stripe-go/testing" | ||
) | ||
|
||
func TestCheckoutSessionGet(t *testing.T) { | ||
session, err := Get("cs_123", nil) | ||
assert.Nil(t, err) | ||
assert.NotNil(t, session) | ||
} | ||
|
||
func TestCheckoutSessionNew(t *testing.T) { | ||
session, err := New(&stripe.CheckoutSessionParams{ | ||
CancelURL: stripe.String("https://stripe.com/cancel"), | ||
ClientReferenceID: stripe.String("1234"), | ||
LineItems: []*stripe.CheckoutSessionLineItemParams{ | ||
{ | ||
Amount: stripe.Int64(1234), | ||
Currency: stripe.String(string(stripe.CurrencyUSD)), | ||
Description: stripe.String("description"), | ||
Images: []*string{ | ||
stripe.String("https://stripe.com/image1"), | ||
}, | ||
Name: stripe.String("name"), | ||
Quantity: stripe.Int64(2), | ||
}, | ||
}, | ||
PaymentIntentData: &stripe.CheckoutSessionPaymentIntentDataParams{ | ||
Description: stripe.String("description"), | ||
Shipping: &stripe.ShippingDetailsParams{ | ||
Address: &stripe.AddressParams{ | ||
Line1: stripe.String("line1"), | ||
City: stripe.String("city"), | ||
}, | ||
Carrier: stripe.String("carrier"), | ||
Name: stripe.String("name"), | ||
}, | ||
}, | ||
PaymentMethodTypes: []*string{ | ||
stripe.String("card"), | ||
}, | ||
SuccessURL: stripe.String("https://stripe.com/success"), | ||
}) | ||
assert.Nil(t, err) | ||
assert.NotNil(t, session) | ||
} | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,136 @@ | ||
package stripe | ||
|
||
import ( | ||
"encoding/json" | ||
) | ||
|
||
// CheckoutSessionDisplayItemType is the list of allowed values for the display item type. | ||
type CheckoutSessionDisplayItemType string | ||
|
||
// List of values that CheckoutSessionDisplayItemType can take. | ||
const ( | ||
CheckoutSessionDisplayItemTypeCustom CheckoutSessionDisplayItemType = "custom" | ||
CheckoutSessionDisplayItemTypePlan CheckoutSessionDisplayItemType = "plan" | ||
CheckoutSessionDisplayItemTypeSKU CheckoutSessionDisplayItemType = "sku" | ||
) | ||
|
||
// CheckoutSessionLineItemParams is the set of parameters allowed for a line item | ||
// on a checkout session. | ||
type CheckoutSessionLineItemParams struct { | ||
Amount *int64 `form:"amount"` | ||
Currency *string `form:"currency"` | ||
Description *string `form:"description"` | ||
Images []*string `form:"images"` | ||
Name *string `form:"name"` | ||
Quantity *int64 `form:"quantity"` | ||
} | ||
|
||
// CheckoutSessionPaymentIntentDataTransferDataParams is the set of parameters allowed for the | ||
// transfer_data hash. | ||
type CheckoutSessionPaymentIntentDataTransferDataParams struct { | ||
Destination *string `form:"destination"` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this also have There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah, got it. Okay, thanks! |
||
} | ||
|
||
// CheckoutSessionPaymentIntentDataParams is the set of parameters allowed for the | ||
// payment intent creation on a checkout session. | ||
type CheckoutSessionPaymentIntentDataParams struct { | ||
Params `form:"*"` | ||
ApplicationFeeAmount *int64 `form:"application_fee_amount"` | ||
CaptureMethod *string `form:"capture_method"` | ||
Description *string `form:"description"` | ||
OnBehalfOf *string `form:"on_behalf_of"` | ||
ReceiptEmail *string `form:"receipt_email"` | ||
Shipping *ShippingDetailsParams `form:"shipping"` | ||
StatementDescriptor *string `form:"statement_descriptor"` | ||
TransferData *CheckoutSessionPaymentIntentDataTransferDataParams `form:"transfer_data"` | ||
} | ||
|
||
// CheckoutSessionSubscriptionDataItemsParams is the set of parameters allowed for one item on a | ||
// checkout session associated with a subscription. | ||
type CheckoutSessionSubscriptionDataItemsParams struct { | ||
Plan *string `form:"plan"` | ||
Quantity *int64 `form:"quantity"` | ||
} | ||
|
||
// CheckoutSessionSubscriptionDataParams is the set of parameters allowed for the subscription | ||
// creation on a checkout session. | ||
type CheckoutSessionSubscriptionDataParams struct { | ||
Params `form:"*"` | ||
Items *CheckoutSessionSubscriptionDataItemsParams `form:"items"` | ||
TrialEnd *int64 `form:"trial_end"` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This might also need its own There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ah yes I forgot to ask you: does it just work? Do we explicitly go through nested There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You'd have to write a test to be 100% sure, but yeah, The one downside of course is that There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Woot that magically just works. Nice catch! I think it's likely easier and more explicit that way than having to do something custom that users would not expect. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Okay, WFM. |
||
TrialPeriodDays *int64 `form:"trial_period_days"` | ||
} | ||
|
||
// CheckoutSessionParams is the set of parameters that can be used when creating | ||
// a checkout session. | ||
// For more details see https://stripe.com/docs/api/checkout/sessions/create | ||
type CheckoutSessionParams struct { | ||
Params `form:"*"` | ||
BillingAddressCollection *string `form:"billing_address_collection"` | ||
CancelURL *string `form:"cancel_url"` | ||
ClientReferenceID *string `form:"client_reference_id"` | ||
Customer *string `form:"customer"` | ||
CustomerEmail *string `form:"customer_email"` | ||
LineItems []*CheckoutSessionLineItemParams `form:"line_items"` | ||
Locale *string `form:"locale"` | ||
PaymentIntentData *CheckoutSessionPaymentIntentDataParams `form:"payment_intent_data"` | ||
PaymentMethodTypes []*string `form:"payment_method_types"` | ||
SubscriptionData *CheckoutSessionSubscriptionDataParams `form:"subscription_data"` | ||
SuccessURL *string `form:"success_url"` | ||
} | ||
|
||
// CheckoutSessionDisplayItemCustom represents an item of type custom in a checkout session | ||
type CheckoutSessionDisplayItemCustom struct { | ||
Description string `json:"description"` | ||
Images []string `json:"images"` | ||
Name string `json:"name"` | ||
} | ||
|
||
// CheckoutSessionDisplayItem represents one of the items in a checkout session. | ||
type CheckoutSessionDisplayItem struct { | ||
Amount int64 `json:"amount"` | ||
Currency Currency `json:"currency"` | ||
Custom *CheckoutSessionDisplayItemCustom `json:"custom"` | ||
Quantity int64 `json:"quantity"` | ||
Plan *Plan `json:"plan"` | ||
SKU *SKU `json:"sku"` | ||
Type CheckoutSessionDisplayItemType `json:"type"` | ||
} | ||
|
||
// CheckoutSession is the resource representing a Stripe checkout session. | ||
// For more details see https://stripe.com/docs/api/checkout/sessions/object | ||
type CheckoutSession struct { | ||
CancelURL string `json:"cancel_url"` | ||
ClientReferenceID string `json:"client_reference_id"` | ||
Customer *Customer `json:"customer"` | ||
CustomerEmail string `json:"customer_email"` | ||
Deleted bool `json:"deleted"` | ||
DisplayItems []*CheckoutSessionDisplayItem `json:"display_items"` | ||
ID string `json:"id"` | ||
Livemode bool `json:"livemode"` | ||
Locale string `json:"locale"` | ||
Object string `json:"object"` | ||
PaymentIntent *PaymentIntent `json:"payment_intent"` | ||
PaymentMethodTypes []string `json:"payment_method_types"` | ||
Subscription *Subscription `json:"subscription"` | ||
SuccessURL string `json:"success_url"` | ||
} | ||
|
||
// UnmarshalJSON handles deserialization of a checkout session. | ||
// This custom unmarshaling is needed because the resulting | ||
// property may be an id or the full struct if it was expanded. | ||
func (p *CheckoutSession) UnmarshalJSON(data []byte) error { | ||
if id, ok := ParseID(data); ok { | ||
p.ID = id | ||
return nil | ||
} | ||
|
||
type session CheckoutSession | ||
var v session | ||
if err := json.Unmarshal(data, &v); err != nil { | ||
return err | ||
} | ||
|
||
*p = CheckoutSession(v) | ||
return nil | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we try to exercise
Get
as well?