sites.md

Sites

sitesController := client.SitesController()

Class Name

SitesController

Methods

• Read Site
• Clear Site
• List Chargify Js Public Keys

Read Site

This endpoint allows you to fetch some site data.

Full documentation on Sites in the Advanced Billing UI can be located here.

Specifically, the Clearing Site Data section is extremely relevant to this endpoint documentation.

Relationship invoicing enabled

If site has RI enabled then you will see more settings like:

"customer_hierarchy_enabled": true,
"whopays_enabled": true,
"whopays_default_payer": "self"

You can read more about these settings here: Who Pays & Customer Hierarchy

ReadSite(
    ctx context.Context) (
    models.ApiResponse[models.SiteResponse],
    error)

Response Type

models.SiteResponse

Example Usage

ctx := context.Background()

apiResponse, err := sitesController.ReadSite(ctx)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "site": {
    "id": 0,
    "name": "string",
    "subdomain": "string",
    "currency": "string",
    "seller_id": 0,
    "non_primary_currencies": [
      "string"
    ],
    "relationship_invoicing_enabled": true,
    "customer_hierarchy_enabled": true,
    "whopays_enabled": true,
    "whopays_default_payer": "string",
    "default_payment_collection_method": "string",
    "organization_address": {
      "street": null,
      "line2": null,
      "city": null,
      "state": null,
      "zip": null,
      "country": null,
      "name": "string",
      "phone": "string"
    },
    "tax_configuration": {
      "kind": "custom",
      "fully_configured": true,
      "destination_address": "shipping_then_billing"
    },
    "net_terms": {
      "default_net_terms": 0,
      "automatic_net_terms": 0,
      "remittance_net_terms": 0,
      "net_terms_on_remittance_signups_enabled": false,
      "custom_net_terms_enabled": false
    },
    "test": true,
    "allocation_settings": {
      "upgrade_charge": "prorated",
      "downgrade_credit": "none",
      "accrue_charge": "true"
    }
  }
}

Clear Site

This call is asynchronous and there may be a delay before the site data is fully deleted. If you are clearing site data for an automated test, you will need to build in a delay and/or check that there are no products, etc., in the site before proceeding.

This functionality will only work on sites in TEST mode. Attempts to perform this on sites in “live” mode will result in a response of 403 FORBIDDEN.

ClearSite(
    ctx context.Context,
    cleanupScope *models.CleanupScope) (
    http.Response,
    error)

Parameters

Parameter	Type	Tags	Description
cleanupScope	*models.CleanupScope	Query, Optional	all: Will clear all products, customers, and related subscriptions from the site. customers: Will clear only customers and related subscriptions (leaving the products untouched) for the site. Revenue will also be reset to 0. Use in query cleanup_scope=all. Default: "all"

Response Type

``

Example Usage

ctx := context.Background()

cleanupScope := models.CleanupScope("all")

resp, err := sitesController.ClearSite(ctx, &cleanupScope)
if err != nil {
    log.Fatalln(err)
} else {
    fmt.Println(resp.StatusCode)
}

List Chargify Js Public Keys

This endpoint returns public keys used for Chargify.js.

ListChargifyJsPublicKeys(
    ctx context.Context,
    input ListChargifyJsPublicKeysInput) (
    models.ApiResponse[models.ListPublicKeysResponse],
    error)

Parameters

Parameter	Type	Tags	Description
page	*int	Query, Optional	Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned. Use in query page=1. Default: 1 Constraints: >= 1
perPage	*int	Query, Optional	This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200. Use in query per_page=200. Default: 20 Constraints: <= 200

Response Type

models.ListPublicKeysResponse

Example Usage

ctx := context.Background()

collectedInput := advancedbilling.ListChargifyJsPublicKeysInput{
    Page:    models.ToPointer(2),
    PerPage: models.ToPointer(50),
}

apiResponse, err := sitesController.ListChargifyJsPublicKeys(ctx, collectedInput)
if err != nil {
    log.Fatalln(err)
} else {
    // Printing the result and response
    fmt.Println(apiResponse.Data)
    fmt.Println(apiResponse.Response.StatusCode)
}

Example Response (as JSON)

{
  "chargify_js_keys": [
    {
      "public_key": "chjs_ftrxt7c4fv6f74wchjs_5zyn7gnwv",
      "requires_security_token": false,
      "created_at": "2021-01-01T05:00:00-04:00"
    }
  ],
  "meta": {
    "total_count": 1,
    "current_page": 1,
    "total_pages": 1,
    "per_page": 10
  }
}