Graph API Version

Extended Credit

Reading

An Extended Credit object

Example

Graph API Explorer
GET /v5.0/{extended-credit-id} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '/{extended-credit-id}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "/{extended-credit-id}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "/{extended-credit-id}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
// For more complex open graph stories, use `FBSDKShareAPI`
// with `FBSDKShareOpenGraphContent`
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"/{extended-credit-id}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
id
numeric string

The ID of the extended credit line

allocated_amount

The total amount of credit that has been granted to other businesses

balance

The total amount spent. This is calculated by adding parent ad account and all child ad accounts

credit_available

The credit available to this business

credit_type
enum

The type of extended credit used. The most common are ADS_BUSINESS and ADS_SEQUENTIAL

is_access_revoked
bool

Returns true if credit owner removed access for previously shared credit line

is_automated_experience
bool

Whether this credential is using the fully automated experience

last_payment_time
datetime

Time when the last payment was made

legal_entity_name
string

The legal entity name of the owner of a line

liable_biz_name
string

When this credit is chosen as the payment method, the business name of the liable_party

max_balance

The amount of credit available to a specific business

online_max_balance

The raw credit limit for an entire business

owner_business

The business account responsible for extended credit payment

owner_business_name
string

The name of the business account responsible for extended credit payment

partition_from
string

The name of the business that granted the credit line. For ADS_SEQUENTIAL credit types

send_bill_to_biz_name
string

When this credit is chosen as the payment method, the business name of the bill_to_party

Edges

EdgeDescription

Invoice group for extended credit account, all ad accounts in the same group will generate one consolidated invoice

Validation Rules

ErrorDescription
100Invalid parameter

Creating

You can't perform this operation on this endpoint.

Updating

You can't perform this operation on this endpoint.

Deleting

You can't perform this operation on this endpoint.