Skip to content

Latest commit

 

History

History
425 lines (316 loc) · 20.8 KB

README.md

File metadata and controls

425 lines (316 loc) · 20.8 KB

Checkouts

(Checkouts)

Overview

Available Operations

  • List - List Checkout Sessions
  • Create - Create Checkout Session
  • Get - Get Checkout Session
  • Update - Update Checkout Session
  • ClientGet - Get Checkout Session from Client
  • ClientUpdate - Update Checkout Session from Client
  • ClientConfirm - Confirm Checkout Session from Client

List

List checkout sessions.

Scopes: checkouts:read checkouts:write

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Checkouts.List(ctx, operations.CheckoutsListRequest{
        OrganizationID: polargo.Pointer(operations.CreateCheckoutsListQueryParamOrganizationIDFilterArrayOfStr(
            []string{
                "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            },
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.ListResourceCheckout != nil {
        for {
            // handle items

            res, err = res.Next()

            if err != nil {
                // handle error
            }

            if res == nil {
                break
            }
        }
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request operations.CheckoutsListRequest ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.CheckoutsListResponse, error

Errors

Error Type Status Code Content Type
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

Create

Create a checkout session.

Scopes: checkouts:write

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Checkouts.Create(ctx, components.CreateCheckoutCreateCheckoutPriceCreate(
        components.CheckoutPriceCreate{
            CustomerBillingAddress: &components.Address{
                Country: "SE",
            },
            SuccessURL: polargo.String("https://probable-heating.com/"),
            ProductPriceID: "<value>",
        },
    ))
    if err != nil {
        log.Fatal(err)
    }
    if res.Checkout != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
request components.CheckoutCreate ✔️ The request object to use for the request.
opts []operations.Option ➖ The options for this request.

Response

*operations.CheckoutsCreateResponse, error

Errors

Error Type Status Code Content Type
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

Get

Get a checkout session by ID.

Scopes: checkouts:read checkouts:write

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Checkouts.Get(ctx, "<id>")
    if err != nil {
        log.Fatal(err)
    }
    if res.Checkout != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
id string ✔️ The checkout session ID.
opts []operations.Option ➖ The options for this request.

Response

*operations.CheckoutsGetResponse, error

Errors

Error Type Status Code Content Type
apierrors.ResourceNotFound 404 application/json
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

Update

Update a checkout session.

Scopes: checkouts:write

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Checkouts.Update(ctx, "<value>", components.CheckoutUpdate{})
    if err != nil {
        log.Fatal(err)
    }
    if res.Checkout != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
id string ✔️ The checkout session ID.
checkoutUpdate components.CheckoutUpdate ✔️ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.CheckoutsUpdateResponse, error

Errors

Error Type Status Code Content Type
apierrors.CheckoutForbiddenError 403 application/json
apierrors.ResourceNotFound 404 application/json
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

ClientGet

Get a checkout session by client secret.

Example Usage

package main

import(
	"context"
	polargo "github.com/polarsource/polar-go"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New()

    res, err := s.Checkouts.ClientGet(ctx, "<value>")
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckoutPublic != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
clientSecret string ✔️ The checkout session client secret.
opts []operations.Option ➖ The options for this request.

Response

*operations.CheckoutsClientGetResponse, error

Errors

Error Type Status Code Content Type
apierrors.ResourceNotFound 404 application/json
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

ClientUpdate

Update a checkout session by client secret.

Example Usage

package main

import(
	"context"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New()

    res, err := s.Checkouts.ClientUpdate(ctx, "<value>", components.CheckoutUpdatePublic{})
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckoutPublic != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
clientSecret string ✔️ The checkout session client secret.
checkoutUpdatePublic components.CheckoutUpdatePublic ✔️ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.CheckoutsClientUpdateResponse, error

Errors

Error Type Status Code Content Type
apierrors.CheckoutForbiddenError 403 application/json
apierrors.ResourceNotFound 404 application/json
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*

ClientConfirm

Confirm a checkout session by client secret.

Orders and subscriptions will be processed.

Example Usage

package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/models/components"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Checkouts.ClientConfirm(ctx, "<value>", components.CheckoutConfirmStripe{})
    if err != nil {
        log.Fatal(err)
    }
    if res.CheckoutPublicConfirmed != nil {
        // handle response
    }
}

Parameters

Parameter Type Required Description
ctx context.Context ✔️ The context to use for the request.
clientSecret string ✔️ The checkout session client secret.
checkoutConfirmStripe components.CheckoutConfirmStripe ✔️ N/A
opts []operations.Option ➖ The options for this request.

Response

*operations.CheckoutsClientConfirmResponse, error

Errors

Error Type Status Code Content Type
apierrors.PaymentError 400 application/json
apierrors.CheckoutForbiddenError 403 application/json
apierrors.ResourceNotFound 404 application/json
apierrors.HTTPValidationError 422 application/json
apierrors.APIError 4XX, 5XX */*