Skip to content

SubscriptionItemsAPI.md

Latest commit

 

History

History
353 lines (227 loc) · 10.9 KB

SubscriptionItemsAPI.md

File metadata and controls

353 lines (227 loc) · 10.9 KB

\SubscriptionItemsAPI

All URIs are relative to https://connto.getopenpay.com

Method HTTP request Description
CreateSubscriptionItem Post /subscription-items/ Create Subscription Item
DeleteSubscriptionItem Delete /subscription-items/{subscription_item_id} Delete Subscription Item
GetSubscriptionItem Get /subscription-items/{subscription_item_id} Get Subscription Item
ListSubscriptionItems Post /subscription-items/list List Subscription Items
UpdateSubscriptionItem Put /subscription-items/{subscription_item_id} Update Subscription Item

CreateSubscriptionItem

SubscriptionItemExternal CreateSubscriptionItem(ctx).CreateSubscriptionItemRequest(createSubscriptionItemRequest).Execute()

Create Subscription Item

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/getopenpay/getopenpay-go"
)

func main() {
	createSubscriptionItemRequest := *openapiclient.NewCreateSubscriptionItemRequest("price_dev_abc123", "subi_dev_abc123") // CreateSubscriptionItemRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SubscriptionItemsAPI.CreateSubscriptionItem(context.Background()).CreateSubscriptionItemRequest(createSubscriptionItemRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionItemsAPI.CreateSubscriptionItem``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateSubscriptionItem`: SubscriptionItemExternal
	fmt.Fprintf(os.Stdout, "Response from `SubscriptionItemsAPI.CreateSubscriptionItem`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateSubscriptionItemRequest struct via the builder pattern

Name Type Description Notes
createSubscriptionItemRequest CreateSubscriptionItemRequest

Return type

SubscriptionItemExternal

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteSubscriptionItem

DeleteSubscriptionItemResponse DeleteSubscriptionItem(ctx, subscriptionItemId).DeleteSubscriptionItemRequest(deleteSubscriptionItemRequest).Execute()

Delete Subscription Item

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/getopenpay/getopenpay-go"
)

func main() {
	subscriptionItemId := "subi_dev_abc123" // string | Unique identifier of the subscription_item.
	deleteSubscriptionItemRequest := *openapiclient.NewDeleteSubscriptionItemRequest() // DeleteSubscriptionItemRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SubscriptionItemsAPI.DeleteSubscriptionItem(context.Background(), subscriptionItemId).DeleteSubscriptionItemRequest(deleteSubscriptionItemRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionItemsAPI.DeleteSubscriptionItem``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `DeleteSubscriptionItem`: DeleteSubscriptionItemResponse
	fmt.Fprintf(os.Stdout, "Response from `SubscriptionItemsAPI.DeleteSubscriptionItem`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
subscriptionItemId string Unique identifier of the subscription_item.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteSubscriptionItemRequest struct via the builder pattern

Name Type Description Notes

deleteSubscriptionItemRequest | DeleteSubscriptionItemRequest | |

Return type

DeleteSubscriptionItemResponse

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSubscriptionItem

SubscriptionItemExternal GetSubscriptionItem(ctx, subscriptionItemId).Execute()

Get Subscription Item

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/getopenpay/getopenpay-go"
)

func main() {
	subscriptionItemId := "subi_dev_abc123" // string | Unique identifier of the subscription_item.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SubscriptionItemsAPI.GetSubscriptionItem(context.Background(), subscriptionItemId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionItemsAPI.GetSubscriptionItem``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSubscriptionItem`: SubscriptionItemExternal
	fmt.Fprintf(os.Stdout, "Response from `SubscriptionItemsAPI.GetSubscriptionItem`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
subscriptionItemId string Unique identifier of the subscription_item.

Other Parameters

Other parameters are passed through a pointer to a apiGetSubscriptionItemRequest struct via the builder pattern

Name Type Description Notes

Return type

SubscriptionItemExternal

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListSubscriptionItems

ListResponseSubscriptionItemExternal ListSubscriptionItems(ctx).SubscriptionItemQueryParams(subscriptionItemQueryParams).Execute()

List Subscription Items

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/getopenpay/getopenpay-go"
)

func main() {
	subscriptionItemQueryParams := *openapiclient.NewSubscriptionItemQueryParams("subi_dev_abc123") // SubscriptionItemQueryParams | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SubscriptionItemsAPI.ListSubscriptionItems(context.Background()).SubscriptionItemQueryParams(subscriptionItemQueryParams).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionItemsAPI.ListSubscriptionItems``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListSubscriptionItems`: ListResponseSubscriptionItemExternal
	fmt.Fprintf(os.Stdout, "Response from `SubscriptionItemsAPI.ListSubscriptionItems`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListSubscriptionItemsRequest struct via the builder pattern

Name Type Description Notes
subscriptionItemQueryParams SubscriptionItemQueryParams

Return type

ListResponseSubscriptionItemExternal

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSubscriptionItem

SubscriptionItemExternal UpdateSubscriptionItem(ctx, subscriptionItemId).UpdateSubscriptionItemRequest(updateSubscriptionItemRequest).Execute()

Update Subscription Item

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/getopenpay/getopenpay-go"
)

func main() {
	subscriptionItemId := "subi_dev_abc123" // string | Unique identifier of the subscription_item.
	updateSubscriptionItemRequest := *openapiclient.NewUpdateSubscriptionItemRequest() // UpdateSubscriptionItemRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.SubscriptionItemsAPI.UpdateSubscriptionItem(context.Background(), subscriptionItemId).UpdateSubscriptionItemRequest(updateSubscriptionItemRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `SubscriptionItemsAPI.UpdateSubscriptionItem``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `UpdateSubscriptionItem`: SubscriptionItemExternal
	fmt.Fprintf(os.Stdout, "Response from `SubscriptionItemsAPI.UpdateSubscriptionItem`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
subscriptionItemId string Unique identifier of the subscription_item.

Other Parameters

Other parameters are passed through a pointer to a apiUpdateSubscriptionItemRequest struct via the builder pattern

Name Type Description Notes

updateSubscriptionItemRequest | UpdateSubscriptionItemRequest | |

Return type

SubscriptionItemExternal

Authorization

HTTPBearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]